Creates new stream and reads stream descriptive data, including stream state, from binary file.
Syntax
FORTRAN:
errstatus = vslloadstreamf( stream, fname )
C:
errstatus = vslLoadStreamF( &stream, fname );
Input Parameters
Name |
Type |
Description |
|---|---|---|
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 |
|---|---|---|
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 vslLoadStreamF function creates a new stream and reads stream descriptive data, including the stream state, from the binary file. A new random stream is created using the stream descriptive data from the binary file with the name fname. If the stream cannot be read (for example, an I/O error occurs or the file format is invalid), errstatus has a non-zero value. To save random stream to the file, use vslSaveStreamF function.
Caution
Calling vslLoadStreamF with a previously initialized stream pointer can have unintended consequences such as a memory leak. To initialize a stream which has been in use until calling vslLoadStreamF, you should call the vslDeleteStream function first to deallocate the resources.
Return Values
- VSL_ERROR_OK, VSL_STATUS_OK
Indicates no error, execution is successful.
- VSL_ERROR_NULL_PTR
fname is a NULL pointer.
- 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.
- VSL_RNG_ERROR_BAD_FILE_FORMAT
Unknown file format.
- VSL_RNG_ERROR_UNSUPPORTED_FILE_VER
File format version is unsupported.