vslNewStream

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 4/28/2026

Version

Public

vslNewStream

Creates and initializes a random stream.

Syntax

statusvslNewStream ( &stream , brng , seed );

Include Files

mkl.h

Input Parameters

Name	Type	Description
`brng`	const MKL_INT	Index of the basic generator to initialize the stream. See Table “Values of brng parameter” for specific value.
`seed`	const MKL_UINT	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`	VSLStreamStatePtr*	Stream state descriptor

Description

vslNewStream 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. Use this function to create and initialize a new stream with a 32-bit seed only. If you need to provide multiple initial conditions such as several 32-bit or wider seeds, use the function vslNewStreamEx . See [VSNotes] 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 vsl iNewAbstractStream (Creates and initializes an abstract random stream for integer arrays.) , vsl sNewAbstractStream (Creates and initializes an abstract random stream for single precision floating-point arrays.) or vsl dNewAbstractStream (Creates and initializes an abstract random stream for double precision floating-point arrays.) to utilize integer, single-precision or double-precision external random data respectively.

Product and Performance Information Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex . Notice revision #20201201

Return Values

VSL_ERROR_OK , VSL_STATUS_OK: Indicates no error, execution is successful.
VSL_RNG_ERROR_INVALID_BRNG_INDEX: BRNG index is invalid.
VSL_ERROR_MEM_FAILURE: System cannot allocate memory for stream .
VSL_RNG_ERROR_NONDETERMINISTIC_NOT_SUPPORTED: Non-deterministic random number generator is not supported.
VSL_RNG_ERROR_ARS5_NOT_SUPPORTED: ARS-5 random number generator is not supported on the CPU running the application.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for C

vslNewStream

Syntax

Include Files

Input Parameters

Output Parameters

Description

Return Values