vslDeleteStream
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
- streamparameter is aNULLpointer.
- VSL_RNG_ERROR_BAD_STREAM
- streamis not a valid random stream.