oneapi::mkl::rng::beta

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 3/31/2021

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-C206075F-528C-4889-91F2-AD146E8E9C74

View Details

oneapi::mkl::rng::beta

Generates beta distributed random values.

Description
API

Description

The oneapi::mkl::rng::beta class object is used in the oneapi::mkl::rng::generate function to provide random numbers with beta distribution that has shape parameters p and q, displacement a, and scale parameter (b, β), where p, q, a, and .

The probability density function is given by:

where B(p, q) is the complete beta function.

The cumulative distribution function is as follows:

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

API

Syntax

template<typename RealType = float,
  typename Method = beta_method::by_default>
  class beta {
  public:
  using method_type = Method; using result_type = RealType;
  beta(): beta((RealType)1.0, (RealType)1.0, (RealType)(0.0),
  (RealType)(1.0)){} explicit beta(RealType p, RealType q, RealType a,
  RealType b);
  explicit beta(const param_type& pt);
  RealType p() const;
  RealType q() const;
  RealType a() const;
  RealType b() const;
  param_type param() const;
  void param(const param_type& pt);
};

Devices supported: CPU and GPU.

Include Files

oneapi/mkl/rng.hpp

Template Parameters

typename RealType = float

Type of the produced values. The specific values are as follows:

float

double

typename Method = oneapi::mkl::rng::beta_method::by_default

Generation method. The specific values are as follows:

oneapi::mkl::rng::beta_method::cja

oneapi::mkl::rng::beta_method::cja_accurate

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

Input Parameters

Name	Type	Description
p	`RealType (float, double)`	Shape `p`
q	`RealType (float, double)`	Shape `q`
a	`RealType (float, double)`	Displacement `a`.
b	`RealType (float, double)`	Scalefactor `b`.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

oneapi::mkl::rng::beta

Description

API