vslCopyStream
vslCopyStream
Creates a copy of a random stream.
Syntax
status
=
vslCopyStream
(
&newstream
,
srcstream
);
Include Files
- mkl.h
Input Parameters
Name | Type | Description |
|---|---|---|
srcstream | const VSLStreamStatePtr | Pointer to the stream state structure to be copied |
Output Parameters
Name | Type | Description |
|---|---|---|
newstream | VSLStreamStatePtr* | Copied random stream descriptor |
Description
The function creates an exact copy of
srcstream
and stores its descriptor to newstream
.Return Values
- VSL_ERROR_OK, VSL_STATUS_OK
- Indicates no error, execution is successful.
- VSL_ERROR_NULL_PTR
- srcstreamparameter is aNULLpointer.
- VSL_RNG_ERROR_BAD_STREAM
- srcstreamis not a valid random stream.
- VSL_ERROR_MEM_FAILURE
- System cannot allocate memory fornewstream.