Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

  • 0.9
  • 09/09/2020
  • Public Content
Contents

vslLoadStreamF

Creates new stream and reads stream descriptive data, including stream state, from binary file.

Syntax

errstatus
=
vslLoadStreamF
(
&stream
,
fname
);
Include Files
  • mkl.h
Input Parameters
Name
Type
Description
fname
const char*
File name specified as a null-terminated string
Output Parameters
Name
Type
Description
stream
VSLStreamStatePtr*
Pointer to a new random stream
errstatus
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.
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.
Optimization Notice
Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.
Notice revision #20110804
This notice covers the following instruction sets: SSE2, SSE4.2, AVX2, AVX-512.
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.
VSL_RNG_ERROR_NONDETERMINISTIC_NOT_SUPPORTED
Non-deterministic random number generator is not supported.
VSL_RNG_ERROR_ARS5_NOT_SUPPORTED
ARS-5 random number generator is not supported on the CPU running the application.

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804