vslGetStreamStateBrng
vslGetStreamStateBrng
Returns index of a basic generator used for generation of a given random stream.
Syntax
brng
=
vslGetStreamStateBrng
(
stream
);
Include Files
- mkl.h
Input Parameters
Name | Type | Description |
|---|---|---|
stream | const VSLStreamStatePtr | Pointer to the stream state structure |
Output Parameters
Name | Type | Description |
|---|---|---|
brng | int | Index of the basic generator assigned for the generation of stream ; negative in case of an error |
Description
The
vslGetStreamStateBrng
function retrieves the index of a basic generator used for generation of a given random stream.Return Values
- VSL_ERROR_NULL_PTR
- streamis aNULLpointer.
- VSL_RNG_ERROR_BAD_STREAM
- streamis not a valid random stream.