Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

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

Document Table of Contents

vslSaveStreamM

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

Syntax

errstatus = vslSaveStreamM( stream, memptr );

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

stream

const VSLStreamStatePtr

Random stream to be written to the memory

memptr

char*

Memory buffer to save random stream descriptive data to

Output Parameters

Name

Type

Description

errstatus

int

Error status of the operation

Description

The vslSaveStreamM 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 vslNewStream-like or vslCopyStream-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 vslGetStreamSize 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 vslLoadStreamM 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.