Developer Reference for Intel® oneAPI Math Kernel Library for Fortran
A newer version of this document is available. Customers should click here to go to the newest version.
vslGetBrngProperties
vslGetBrngProperties Returns structure with properties of a given basic generator.
Syntax
status = vslgetbrngproperties ( brng , properties )
Include Files
mkl.fi , mkl_vsl.f90
Input Parameters
Name |
Type |
Description |
|---|---|---|
brng |
INTEGER (KIND=4) , INTENT(IN) |
Number (index) of the registered basic generator; used for identification. See specific values in Table “Values of brng parameter” . Negative values indicate the registration error. |
Output Parameters
Name |
Type |
Description |
|---|---|---|
properties |
TYPE(VSL_BRNG_PROPERTIES) , INTENT(OUT) |
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.