GetStreamSize

Computes size of memory necessary to hold the random stream.

Syntax

Fortran:

memsize = vslgetstreamsize( stream )

memsize = vslGetStreamSize( 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 Parameters

Name	Type	Description
stream	FORTRAN 77: INTEGER4 stream(2) Fortran 90:* TYPE(VSL_STREAM_STATE), INTENT(IN) C: const VSLStreamStatePtr	Random stream

Name

Type

Description

stream

FORTRAN 77: INTEGER*4 stream(2)

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

C: const VSLStreamStatePtr

Random stream

Output Parameters

Name	Type	Description
memsize	Fortran: INTEGER C: int	Amount of memory in bytes necessary to hold descriptive data of random stream stream

Name

Type

Description

memsize

Fortran: INTEGER

C: int

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

Description

The GetStreamSize 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 SaveStreamM 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.
VSL_ERROR_BAD_STREAM: stream is not a valid random stream.