Visible to Intel only — GUID: GUID-1719AFCA-2B7C-4729-859A-F95920A2C27E
Visible to Intel only — GUID: GUID-1719AFCA-2B7C-4729-859A-F95920A2C27E
chi_square
Generates chi-square distributed random values.
Description
The chi_square class object is used in the generate function to provide random numbers with chi-square distribution and ν degrees of freedom, .
The probability density function is:
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/76AE2F61-1A43-45B7-9827-917AFB0A6559-low.png)
The cumulative distribution function is:
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/42348428-AD84-4A19-9179-A3B7EBF09508-low.png)
API
Syntax
namespace oneapi::mkl::rng {
template<typename RealType = float,
typename Method = chi_square_method::by_default>
class chi_square {
public:
using method_type = Method;
using result_type = RealType;
chi_square(): chi_square(5){}
explicit chi_square(std::int32_t n);
explicit chi_square(const param_type& pt);
std::int32_t n() 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::chi_square_method::by_default |
Generation method. The specific values are as follows: oneapi::mkl::rng::chi_square_method::gamma_based See brief descriptions of the methods in Distributions Template Parameter Method. |
Input Parameters
Name |
Type |
Description |
---|---|---|
n |
std::int32_t |
Degrees of freedom. |