Visible to Intel only — GUID: GUID-D916B19C-C58F-48F3-B71A-8FD0E45F4294
Visible to Intel only — GUID: GUID-D916B19C-C58F-48F3-B71A-8FD0E45F4294
vslGetStreamStateBrng
Returns index of a basic generator used for generation of a given random stream.
Syntax
brng = vslgetstreamstatebrng( stream )
Include Files
- mkl.fi, mkl_vsl.f90
Input Parameters
Name |
Type |
Description |
---|---|---|
stream |
TYPE(VSL_STREAM_STATE), TINTENT(IN) |
Descriptor of the stream state |
Output Parameters
Name |
Type |
Description |
---|---|---|
brng |
INTEGER |
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
-
stream is a NULL pointer.
- VSL_RNG_ERROR_BAD_STREAM
-
stream is not a valid random stream.