vslGetStreamStateBrng

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

Syntax

FORTRAN:

brng = vslgetstreamstatebrng( stream )

C:

brng = vslGetStreamStateBrng( stream );

Include Files

Input Parameters

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

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.


Submit feedback on this help topic