Visible to Intel only — GUID: GUID-1029DC5E-250F-4D92-8C8D-868E2359B414
Visible to Intel only — GUID: GUID-1029DC5E-250F-4D92-8C8D-868E2359B414
oneapi::mkl::rng::chi_square
Generates chi-square distributed random values.
Description
The oneapi::mkl::rng::chi_square class object is used in the oneapi::mkl::rng::generate function to provide random numbers with chi-square distribution and ν degrees of freedom, n∈N, n > 0.
The probability density function is:
The cumulative distribution function is:
API
Syntax
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 = oneamkl::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. |