vslGetBrngProperties

Returns structure with properties of a given basic generator.

Syntax

FORTRAN:

status = vslgetbrngproperties( brng, properties )

status = vslGetBrngProperties( brng, &properties );

Include Files

Fortran 90: mkl_vsl.f90
C: mkl_vsl_functions.h

Input Parameters

Name	Type	Description
brng	Fortran: INTEGER(KIND=4), INTENT(IN) C: const int	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.

Name

Type

Description

brng

Fortran: INTEGER(KIND=4), INTENT(IN)

C: const int

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.

Note

FORTRAN 77 support is unavailable for this function.

Output Parameters

Name	Type	Description
properties	Fortran: TYPE(VSL_BRNG_PROPERTIES), INTENT(OUT) C: VSLBRngProperties*	Pointer to the structure containing properties of the generator with number `brng`

Name

Type

Description

properties

Fortran: TYPE(VSL_BRNG_PROPERTIES), INTENT(OUT)

C: 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.