LoadStreamM

Creates a new stream and reads stream descriptive data, including stream state, from the memory buffer.

Syntax

Fortran:

errstatus = vslloadstreamm( stream, memptr )

errstatus = vslLoadStreamM( &stream, memptr );

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
memptr	FORTRAN 77: INTEGER1 Fortran 90:* INTEGER1, INTENT(IN) C: const char	Fortran: Memory buffer to load random stream descriptive data from C: Memory buffer to load random stream descriptive data from

Name

Type

Description

memptr

FORTRAN 77: INTEGER*1

Fortran 90: INTEGER*1, INTENT(IN)

C: const char*

Fortran: Memory buffer to load random stream descriptive data from

C: Memory buffer to load random stream descriptive data from

Output Parameters

Name	Type	Description
stream	FORTRAN 77: INTEGER4 stream(2) Fortran 90:* TYPE(VSL_STREAM_STATE), INTENT(OUT) C: VSLStreamStatePtr*	Fortran: Descriptor of a new random stream C: Pointer to a new random stream
errstatus	Fortran: INTEGER C: int	Error status of the operation

Name

Type

Description

stream

FORTRAN 77: INTEGER*4 stream(2)

Fortran 90: TYPE(VSL_STREAM_STATE), INTENT(OUT)

C: VSLStreamStatePtr*

Fortran: Descriptor of a new random stream

C: Pointer to a new random stream

errstatus

Fortran: INTEGER

C: int

Error status of the operation

Description

The LoadStreamM function creates a new stream and reads stream descriptive data, including the stream state, from the memory buffer. A new random stream is created using the stream descriptive data from the memory pointer by memptr. If the stream cannot be read (for example, memptr is invalid), errstatus has a non-zero value. To save random stream to the memory, use SaveStreamM function. Use the service routine GetStreamSize to determine the amount of memory sufficient to hold the random stream.

Return Values

VSL_ERROR_OK, VSL_STATUS_OK: Indicates no error, execution is successful.
VSL_ERROR_NULL_PTR: memptr is a NULL pointer.
VSL_ERROR_MEM_FAILURE: System cannot allocate memory for internal needs.
VSL_RNG_ERROR_BAD_MEM_FORMAT: Descriptive random stream format is unknown.