DeleteStream

Deletes a random stream.

Syntax

Fortran:

status = vsldeletestream( stream )

status = vslDeleteStream( &stream );

Include Files

The FORTRAN 77 interfaces are specified in the mkl_vsl.f77 include file, the Fortran 90 interfaces are specified in the mkl_vsl.f90 include file, and the C interfaces are specified in the mkl_vsl_functions.h include file.

Input/Output Parameters

Name	Type	Description
stream	FORTRAN 77: INTEGER4 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.

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.