vRngUniform Discrete Distribution Generators

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 12/16/2022

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-46FE7EF1-CE00-42CB-891D-17FD96062255

View Details

vRngUniform Discrete Distribution Generators

Generates random numbers uniformly distributed over the interval [a, b).

Syntax

status = virnguniform( method, stream, n, r, a, b )

Include Files

mkl.fi, mkl_vsl.f90

Input Parameters

Name	Type	Description
method	INTEGER, INTENT(IN)	Generation method; the specific value is as follows: VSL_RNG_METHOD_UNIFORM_STD Standard method. Currently there is only one method for this distribution generator.
stream	TYPE (VSL_STREAM_STATE), INTENT(IN)	Descriptor of the stream state structure.
n	INTEGER, INTENT(IN)	Number of random values to be generated
a	INTEGER(KIND=4), INTENT(IN)	Left interval bound a
b	INTEGER(KIND=4), INTENT(IN)	Right interval bound b

Output Parameters

Name	Type	Description
r	INTEGER(KIND=4), INTENT(OUT)	Vector of `n` random numbers uniformly distributed over the interval `[a,b)`

Description

The vRngUniform function generates random numbers uniformly distributed over the interval [a, b), where a, b are the left and right bounds of the interval respectively, and a, b∈Z; a < b.

The probability distribution is given by:

The cumulative distribution function is as follows:

Product and Performance Information
Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex. Notice revision #20201201

Product and Performance Information

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.

Notice revision #20201201

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_BAD_UPDATE: Callback function for an abstract BRNG returns an invalid number of updated entries in a buffer, that is, < 0 or > nmax.
VSL_RNG_ERROR_NO_NUMBERS: Callback function for an abstract BRNG returns 0 as the number of updated entries in a buffer.
VSL_RNG_ERROR_QRNG_PERIOD_ELAPSED: Period of the generator has been exceeded.
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.

Parent topic: Discrete Distributions

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

vRngUniform Discrete Distribution Generators