Intel® oneAPI Math Kernel Library Developer Reference - C

vRngUniformBits64

Generates uniformly distributed bits in 64-bit chunks.

Syntax

status = viRngUniformBits64( method, stream, n, r );

Include Files

Input Parameters

Name

Type

Description

method

const MKL_INT

Generation method; the specific value is

VSL_RNG_METHOD_UNIFORMBITS64_STD

stream

VSLStreamStatePtr

Pointer to the stream state structure

n

const MKL_INT

Number of random values to be generated

Output Parameters

Name

Type

Description

r

unsigned MKL_INT64*

Vector of n 64-bit random integer numbers with uniform bit distribution.

Description

The vRngUniformBits64 function generates uniformly distributed bits in 64-bit chunks. Unlike vRngUniformBits, which provides the output of underlying integer recurrence and does not guarantee uniform distribution across bits, vRngUniformBits64 is designed to ensure each bit in the 64-bit chunk is uniformly distributed. See VS Notes for details.

Optimization Notice

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804

This notice covers the following instruction sets: SSE2, SSE4.2, AVX2, AVX-512.

Return Values

VSL_ERROR_OK, VSL_STATUS_OK

Indicates no error, execution is successful.

VSL_ERROR_NULL_PTR

stream is a NULL pointer.

VSL_RNG_ERROR_BAD_STREAM

stream is not a valid random stream.

VSL_RNG_ERROR_BRNG_NOT_SUPPORTED

BRNG is not supported by the function.

VSL_RNG_ERROR_NONDETERM_NRETRIES_EXCEEDED

Number of retries to generate a random number by using non-deterministic random number generator exceeds threshold.

VSL_RNG_ERROR_ARS5_NOT_SUPPORTED

ARS-5 random number generator is not supported on the CPU running the application.