Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 11/07/2023
Public

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

Document Table of Contents

vslGetStreamSize

Computes size of memory necessary to hold the random stream.

Syntax

memsize = vslGetStreamSize( stream );

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

stream

const VSLStreamStatePtr

Random stream

Output Parameters

Name

Type

Description

memsize

int

Amount of memory in bytes necessary to hold descriptive data of random stream stream

Description

The vslGetStreamSize function returns the size of memory in bytes which is necessary to hold the given random stream. Use the output of the function to allocate the buffer to which you will save the random stream by means of the vslSaveStreamM function.

Return Values

VSL_ERROR_OK, VSL_STATUS_OK

Indicates no error, execution is successful.

VSL_RNG_ERROR_BAD_STREAM

stream is a NULL pointer.