GetBrngProperties

Returns structure with properties of a given basic generator.

Syntax

Fortran:

status = vslgetbrngproperties( brng, properties )

C:

status = vslGetBrngProperties( brng, &properties );

Include Files

The Fortran 90 interfaces are specified in the mkl_vsl.f90 include file, and the C interfaces are specified in the mkl_vsl_functions.h include file.

Input Parameters

Name

Type

Description

brng

Fortran: INTEGER, 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 iconNote

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

Description

The GetBrngProperties 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.


Submit feedback on this help topic

Copyright © 1994 - 2011, Intel Corporation. All rights reserved.