vslSaveStreamF

Writes random stream descriptive data, including stream state, to binary file.

Syntax

FORTRAN:

errstatus = vslsavestreamf( stream, fname )

errstatus = vslSaveStreamF( stream, fname );

Include Files

FORTRAN 77: mkl_vsl.f77
Fortran 90: mkl_vsl.f90
C: mkl_vsl_functions.h

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 file
fname	FORTRAN 77: CHARACTER() Fortran 90:* CHARACTER(), INTENT(IN) C: const char	Fortran: File name specified as a C-style null-terminated string C: File name specified as a Fortran-style character string

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 file

fname

FORTRAN 77: CHARACTER(*)

Fortran 90: CHARACTER(*), INTENT(IN)

C: const char*

Fortran: File name specified as a C-style null-terminated string

C: File name specified as a Fortran-style character string

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 vslSaveStreamF function writes the random stream descriptive data, including the stream state, to the binary file. Random stream descriptive data is saved to the binary file with the name fname. The random stream stream must be a valid stream created by vslNewStream-like or vslCopyStream-like service routines. If the stream cannot be saved to the file, errstatus has a non-zero value. The random stream can be read from the binary file using the vslLoadStreamF function.

Return Values

VSL_ERROR_OK, VSL_STATUS_OK: Indicates no error, execution is successful.
VSL_ERROR_NULL_PTR: Either fname or stream is a NULL pointer.
VSL_RNG_ERROR_BAD_STREAM: stream is not a valid random stream.
VSL_RNG_ERROR_FILE_OPEN: Indicates an error in opening the file.
VSL_RNG_ERROR_FILE_WRITE: Indicates an error in writing the file.
VSL_RNG_ERROR_FILE_CLOSE: Indicates an error in closing the file.
VSL_ERROR_MEM_FAILURE: System cannot allocate memory for internal needs.