Visible to Intel only — GUID: GUID-CF5B86A2-B348-44F1-97CC-409DD43FDEF6
Visible to Intel only — GUID: GUID-CF5B86A2-B348-44F1-97CC-409DD43FDEF6
vslCopyStreamState
Creates a copy of a random stream state.
Syntax
status = vslcopystreamstate( deststream, srcstream )
Include Files
- mkl.fi, mkl_vsl.f90
Input Parameters
Name |
Type |
Description |
---|---|---|
srcstream |
TYPE(VSL_STREAM_STATE), INTENT(IN) |
Descriptor of the destination stream where the state of scrstream stream is copied |
Output Parameters
Name |
Type |
Description |
---|---|---|
deststream |
TYPE(VSL_STREAM_STATE), INTENT(OUT) |
Descriptor of the stream with the state to be copied |
Description
The vslCopyStreamState 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 vslCopyStream function, which creates a new stream and copies both the stream state and other data from srcstream, the function vslCopyStreamState 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.