mkl::rng::chi_square

Generates chi-square distributed random values.

Syntax

template<typename RealType = float, typename Method = mkl::rng::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 chi_square<RealType, Method>& other);

std::int32_t n() const;

chi_square<RealType, Method>& operator=(const chi_square<RealType, Method>& other);

};

Devices supported: Host and CPU

Include Files

Description

The mkl::rng::chi_square class object is used in the 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:

Template Parameters

typename RealType = float

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

float

double

typename Method = mkl::rng::chi_square_method::by_default

Generation method. The specific values are as follows:

mkl::rng::chi_square_method::gamma_based

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

Input Parameters

Name

Type

Description

n

std::int32_t

Degrees of freedom.