Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 6/24/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

vslSaveStreamF

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

Syntax

errstatus = vslsavestreamf( stream, fname )

Include Files

  • mkl.fi, mkl_vsl.f90

Input Parameters

Name

Type

Description

stream

TYPE(VSL_STREAM_STATE), INTENT(IN)

Random stream to be written to the file

fname

CHARACTER(*), INTENT(IN)

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

Output Parameters

Name

Type

Description

errstatus

INTEGER

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.