Visible to Intel only — GUID: GUID-FB83DA17-03C3-4B22-B674-47C3D54CB044
Visible to Intel only — GUID: GUID-FB83DA17-03C3-4B22-B674-47C3D54CB044
beta
Generates Beta distributed random numbers.
Description
The beta class object is used in the generate function to provide random numbers with beta distribution that has shape parameters and
, displacement
, and scale parameter
, where
,
,
,
.
The probability density function is given by:

The cumulative distribution function is as follows:

Where is the complete beta function.
API
Syntax
namespace oneapi::mkl::rng::device { template<typename RealType, typename Method> 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; std::size_t count_rejected_numbers() const; void param(const param_type& pt); }; }
Include Files
oneapi/mkl/rng/device.hpp
Template Parameters
typename Type |
Type of the produced values. The specific values are as follows:
|
typename Method |
Generation method. The specific values are as follows:
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 |
b |
RealType (float, double) |
Scalefactor |
Special methods
std::size_t count_rejected_numbers() const
Returns the amount of random numbers that were rejected during the last generate function call. If no generate calls, returns 0.