vslDeleteStream

Deletes a random stream.

Syntax

FORTRAN:

status = vsldeletestream( stream )

C:

status = vslDeleteStream( &stream );

Include Files

Input/Output Parameters

Name

Type

Description

stream

FORTRAN 77: INTEGER*4 stream(2)

Fortran 90: TYPE(VSL_STREAM_STATE), INTENT(OUT)

C: VSLStreamStatePtr*

Fortran: Stream state descriptor. Must have non-zero value. After the stream is successfully deleted, the descriptor becomes invalid.

C: 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.


Submit feedback on this help topic