vslGetBrngProperties
vslGetBrngProperties
Returns structure with properties of a given
basic generator.
Syntax
status
=
vslGetBrngProperties
(
brng
,
&properties
);
Include Files
- mkl.h
Input Parameters
Name | Type | Description |
|---|---|---|
brng | const int | Number (index) of the registered basic generator;
used for identification. See specific values in Table
Negative values indicate the registration
error."Values of .brng parameter" |
Output
Parameters
Name | Type | Description |
|---|---|---|
properties | VSLBRngProperties* | Pointer to the structure containing properties of
the generator with number brng |
Description
The
vslGetBrngProperties
function returns a structure
with properties of a given basic generator.Return Values
- VSL_ERROR_OK,VSL_STATUS_OK
- Indicates no error, execution is successful.
- VSL_RNG_ERROR_INVALID_BRNG_INDEX
- BRNG index is invalid.