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

vslDeleteStream

Deletes a random stream.

Syntax

status = vslDeleteStream( &stream );

Include Files

  • mkl.h

Input/Output Parameters

Name

Type

Description

stream

VSLStreamStatePtr*

Stream state descriptor. Must have non-zero value. After the stream is successfully deleted, the pointer is set to NULL.

Description

The function deletes the random stream created by one of the initialization functions.

Return Values

VSL_ERROR_OK, VSL_STATUS_OK

Indicates no error, execution is successful.

VSL_ERROR_NULL_PTR

stream parameter is a NULL pointer.

VSL_RNG_ERROR_BAD_STREAM

stream is not a valid random stream.