Visible to Intel only — GUID: GUID-CE3F51BB-D8D1-4513-839F-A13A894A44BB
Visible to Intel only — GUID: GUID-CE3F51BB-D8D1-4513-839F-A13A894A44BB
gamma
Generates gamma distributed random values.
Description
The gamma class object is used in the generate function to provide random numbers with gamma distribution that has shape parameter , displacement a, and scale parameter
, where
.
The probability density function is given by:
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-2/05BCF4CC-25DE-4AA3-A0AA-D474EA913B67-low.png)
where is the complete gamma function.
The cumulative distribution function is as follows:
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-2/F284B999-78BF-48EB-A24B-187CE5D9BF0F-low.png)
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
namespace oneapi::mkl::rng {
template<typename RealType = float,
typename Method = gamma_method::by_default>
class gamma {
public:
using method_type = Method;
using result_type = RealType;
gamma(): gamma((RealType)1.0, (RealType)0.0, (RealType)1.0){}
explicit gamma(RealType alpha, RealType a, RealType beta);
explicit gamma(const param_type& pt);
RealType alpha() const;
RealType a() const;
RealType beta() 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::gamma_method::by_default |
Generation method. The specific values are as follows: oneapi::mkl::rng::gamma_method::marsaglia oneapi::mkl::rng::gamma_method::marsaglia_accurate See brief descriptions of the methods in Distributions Template Parameter Method. |
Input Parameters
Name |
Type |
Description |
---|---|---|
alpha |
RealType (float, double) |
Shape α |
a |
RealType (float, double) |
Displacement a. |
beta |
RealType (float, double) |
Scalefactor β. |