CopyStreamState

Creates a copy of a random stream state.

Syntax

Fortran:

status = vslcopystreamstate( deststream, srcstream )

status = vslCopyStreamState( deststream, srcstream );

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
srcstream	FORTRAN 77: INTEGER4 srcstream(2) Fortran 90:* TYPE(VSL_STREAM_STATE), INTENT(IN) C: const VSLStreamStatePtr	Fortran: Descriptor of the destination stream where the state of `scrstream` stream is copied C: Pointer to the stream state structure, from which the state structure is copied

Name

Type

Description

srcstream

FORTRAN 77: INTEGER*4 srcstream(2)

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

C: const VSLStreamStatePtr

Fortran: Descriptor of the destination stream where the state of scrstream stream is copied

C: Pointer to the stream state structure, from which the state structure is copied

Output Parameters

Name	Type	Description
deststream	FORTRAN 77: INTEGER4 deststream(2) Fortran 90:* TYPE(VSL_STREAM_STATE), INTENT(OUT) C: VSLStreamStatePtr	Fortran: Descriptor of the stream with the state to be copied C: Pointer to the stream state structure where the stream state is copied

Name

Type

Description

deststream

FORTRAN 77: INTEGER*4 deststream(2)

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

C: VSLStreamStatePtr

Fortran: Descriptor of the stream with the state to be copied

C: Pointer to the stream state structure where the stream state is copied

Description

The CopyStreamState function copies a stream state from srcstream to the existing deststream stream. Both the streams should be generated by the same basic generator. An error message is generated when the index of the BRNG that produced deststream stream differs from the index of the BRNG that generated srcstream stream.

Unlike CopyStream function, which creates a new stream and copies both the stream state and other data from srcstream, the function CopyStreamState copies only srcstream stream state data to the generated deststream stream.

Return Values

VSL_ERROR_OK, VSL_STATUS_OK: Indicates no error, execution is successful.
VSL_ERROR_NULL_PTR: Either srcstream or deststream is a NULL pointer.
VSL_RNG_ERROR_BAD_STREAM: Either srcstream or deststream is not a valid random stream.
VSL_RNG_ERROR_BRNGS_INCOMPATIBLE: BRNG associated with srcstream is not compatible with BRNG associated with deststream.