uniform (Discrete)

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 6/24/2024

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-5CADD63C-65CF-4996-B434-CAB303C8B47D

View Details

uniform (Discrete)

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

Description
API

Description

The uniform class object is used in generate functions to provide random numbers uniformly distributed over the interval [a, b), where a, b are the left and right bounds of the interval respectively, and .

The probability distribution is given by:

The cumulative distribution function is as follows:

API

Syntax

namespace oneapi::mkl::rng::device {
  template<typename Type, typename Method>
  class uniform {
  public:
    using method_type = Method;
    using result_type = Type;

    uniform(): uniform((Type)0,
                  ((std::is_same_v<Method, uniform_method::standard> && sizeof(Type) < 64) ?
                       (1 << 23) :
                       std::numeric_limits<Type>::max())) {};
    explicit uniform(Type a, Type b);
    explicit uniform(const param_type& pt);

    Type a() const;
    Type b() const;
    param_type param() const;
    void param(const param_type& pt);
  };
}

Include Files

oneapi/mkl/rng/device.hpp

Template Parameters

typename Method

Generation method. The specific values are as follows:

oneapi::mkl::rng::device::uniform_method::standard

oneapi::mkl::rng::device::uniform_method::accurate

See brief descriptions of the methods in Distributions Template Parameter Method.

NOTE:

The oneapi::mkl::rng::device::uniform_method::standard uses the float type for underlying BRNG calls. This might cause the produced numbers to have incorrect statistics (due to rounding error) when

. To get proper statistics for this case, use the oneapi::mkl::rng::device::uniform_method::accurate method instead.

Input Parameters

Name	Type	Description
a	`std::int32_t` `std::uint32_t` `std::int64_t` `std::uint64_t`	Left bound `a`
b	`std::int32_t` `std::uint32_t` `std::int64_t` `std::uint64_t`	Right bound `b`

Name

Type

Description

std::int32_t

std::uint32_t

std::int64_t

std::uint64_t

Left bound a

std::int32_t

std::uint32_t

std::int64_t

std::uint64_t

Right bound b

NOTE:

The sample rejection method is used in the case of the 64-bit return type. This enables sequences to not overlap in the case of parallel generation. To ensure the output quality, provide an ample offset between engines.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

uniform (Discrete)

Description

API