vslCopyStreamState
vslCopyStreamState
Creates a copy of a random stream state.
Syntax
status
=
vslCopyStreamState
(
deststream
,
srcstream
);
Include Files
- mkl.h
Input Parameters
Name | Type | Description |
|---|---|---|
srcstream | const VSLStreamStatePtr | Pointer to the stream state structure, from which the state structure is copied |
Output Parameters
Name | Type | Description |
|---|---|---|
deststream | VSLStreamStatePtr | Pointer to the stream state structure where the stream state is 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
- Eithersrcstreamordeststreamis aNULLpointer.
- VSL_RNG_ERROR_BAD_STREAM
- Eithersrcstreamordeststreamis not a valid random stream.
- VSL_RNG_ERROR_BRNGS_INCOMPATIBLE
- BRNG associated withsrcstreamis not compatible with BRNG associated withdeststream.