Creates and initializes a random stream.
Syntax
Fortran:
status = vslnewstream( stream, brng, seed )
C:
status = vslNewStream( &stream, brng, seed );
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 |
|---|---|---|
brng |
FORTRAN 77: INTEGER Fortran 90: INTEGER, INTENT(IN) C: const int |
Index of the basic generator to initialize the stream. See Table Values of brng parameter for specific value. |
seed |
FORTRAN 77: INTEGER Fortran 90: INTEGER, INTENT(IN) C: const unsigned int |
Initial condition of the stream. In the case of a quasi-random number generator seed parameter is used to set the dimension. If the dimension is greater than the dimension that brng can support or is less than 1, then the dimension is assumed to be equal to 1. |
Output Parameters
Name |
Type |
Description |
|---|---|---|
stream |
FORTRAN 77: INTEGER*4 stream(2) Fortran 90: TYPE(VSL_STREAM_STATE), INTENT(OUT) C: VSLStreamStatePtr* |
Stream state descriptor |
Description
For a basic generator with number brng, this function creates a new stream and initializes it with a 32-bit seed. The seed is an initial value used to select a particular sequence generated by the basic generator brng. The function is also applicable for generators with multiple initial conditions. See VSL Notes for a more detailed description of stream initialization for different basic generators.
Note
This function is not applicable for abstract basic random number generators. Please use vsliNewAbstractStream, vslsNewAbstractStream or vsldNewAbstractStream to utilize integer, single-precision or double-precision external random data respectively.