SaveStreamM

Writes random stream descriptive data, including stream state, to a memory buffer.

Syntax

Fortran:

errstatus = vslsavestreamm( stream, memptr )

errstatus = vslSaveStreamM( 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
stream	FORTRAN 77: INTEGER4 stream(2) Fortran 90:* TYPE(VSL_STREAM_STATE), INTENT(IN) C: const VSLStreamStatePtr	Random stream to be written to the memory
memptr	FORTRAN 77: INTEGER1 Fortran 90:* INTEGER1, INTENT(IN) C: char	Fortran: Memory buffer to save random stream descriptive data to C: Memory buffer to save random stream descriptive data to

Name

Type

Description

stream

FORTRAN 77: INTEGER*4 stream(2)

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

C: const VSLStreamStatePtr

Random stream to be written to the memory

memptr

FORTRAN 77: INTEGER*1

Fortran 90: INTEGER*1, INTENT(IN)

C: char*

Fortran: Memory buffer to save random stream descriptive data to

C: Memory buffer to save random stream descriptive data to

Output Parameters

Name	Type	Description
errstatus	Fortran: INTEGER C: int	Error status of the operation

Name

Type

Description

errstatus

Fortran: INTEGER

C: int

Error status of the operation

Description

The SaveStreamM function writes the random stream descriptive data, including the stream state, to the memory at memptr. Random stream stream must be a valid stream created by NewStream-like or CopyStream-like service routines. The memptr parameter must be a valid pointer to the memory of size sufficient to hold the random stream stream. Use the service routine GetStreamSize to determine this amount of memory.

If the stream cannot be saved to the memory, errstatus has a non-zero value. The random stream can be read from the memory pointed by memptr using the LoadStreamM function.

Return Values

VSL_ERROR_OK, VSL_STATUS_OK: Indicates no error, execution is successful.
VSL_ERROR_NULL_PTR: Either memptr or stream is a NULL pointer.
VSL_RNG_ERROR_BAD_STREAM: stream is a NULL pointer.
VSL_ERROR_BAD_STREAM: stream is not a valid random stream.