GetStreamStateBrng

Returns index of a basic generator used for generation of a given random stream.

Syntax

Fortran:

brng = vslgetstreamstatebrng( stream )

brng = vslGetStreamStateBrng( stream );

Include Files

The FORTRAN 77 interfaces are specified in the mkl_vsl.f77 include file, the Fortran 90 interfaces are specified in the mkl_vsl.f90 include file, and the C interfaces are specified in the mkl_vsl_functions.h include file.

Input Parameters

Name	Type	Description
stream	FORTRAN 77: INTEGER4 stream(2) Fortran 90:* TYPE(VSL_STREAM_STATE), TINTENT(IN) C: const VSLStreamStatePtr	Fortran: Descriptor of the stream state C: Pointer to the stream state structure

Name

Type

Description

stream

FORTRAN 77: INTEGER*4 stream(2)

Fortran 90: TYPE(VSL_STREAM_STATE), TINTENT(IN)

C: const VSLStreamStatePtr

Fortran: Descriptor of the stream state

C: Pointer to the stream state structure

Output Parameters

Name	Type	Description
brng	Fortran: INTEGER C: int	Index of the basic generator assigned for the generation of `stream` ; negative in case of an error

Name

Type

Description

brng

Fortran: INTEGER

C: int

Index of the basic generator assigned for the generation of stream ; negative in case of an error

Description

The GetStreamStateBrng 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.