RegisterBrng

Registers user-defined basic generator.

Syntax

Fortran:

brng = vslregisterbrng( properties )

C:

brng = vslRegisterBrng( &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

properties

Fortran: TYPE(VSL_BRNG_PROPERTIES), INTENT(IN)

C: const VSLBRngProperties*

Pointer to the structure containing properties of the basic generator to be registered

Note iconNote

FORTRAN 77 support is unavailable for this function.

Output Parameters

Name

Type

Description

brng

Fortran: INTEGER, INTENT(OUT)

C: int

Number (index) of the registered basic generator; used for identification. Negative values indicate the registration error.

Description

An example of a registration procedure can be found in the respective directory of the VSL examples.

Return Values

VSL_ERROR_OK, VSL_STATUS_OK

Indicates no error, execution is successful.

VSL_RNG_ERROR_BRNG_TABLE_FULL

Registration cannot be completed due to lack of free entries in the table of registered BRNGs.

VSL_RNG_ERROR_BAD_STREAM_STATE_SIZE

Bad value in StreamStateSize field.

VSL_RNG_ERROR_BAD_WORD_SIZE

Bad value in WordSize field.

VSL_RNG_ERROR_BAD_NSEEDS

Bad value in NSeeds field.

VSL_RNG_ERROR_BAD_NBITS

Bad value in NBits field.

VSL_ERROR_NULL_PTR

At least one of the fields iBrng, dBrng, sBrng or InitStream is a NULL pointer.


Submit feedback on this help topic

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