std::chi_squared_distribution (3) - Linux Manuals

std::chi_squared_distribution: std::chi_squared_distribution

NAME

std::chi_squared_distribution - std::chi_squared_distribution

Synopsis

Defined in header <random>
template< class RealType = double > (since C++11)
class chi_squared_distribution;

The chi_squared_distribution produces random numbers x>0 according to the Chi-squared_distribution:

      f(x;n) =

      x(n/2)-1
      e-x/2
      Γ(n/2) 2n/2

Γ is the Gamma_function (See also std::tgamma) and n are the degrees_of_freedom (default 1).
std::chi_squared_distribution satisfies all requirements of RandomNumberDistribution

Template parameters

RealType - The result type generated by the generator. The effect is undefined if this is not one of float, double, or long double.

Member types

Member type Definition
result_type RealType
param_type the type of the parameter set, see RandomNumberDistribution.

Member functions

              constructs new distribution
constructor (public member function)
              resets the internal state of the distribution
reset (public member function)

Generation

              generates the next random number in the distribution
operator() (public member function)

Characteristics

              returns the degrees of freedom (n) distribution parameter
n (public member function)
              gets or sets the distribution parameter object
param (public member function)
              returns the minimum potentially generated value
min (public member function)
              returns the maximum potentially generated value
max (public member function)

Non-member functions

           compares two distribution objects
operator== (function)
operator!=
           performs stream input and output on pseudo-random number distribution
operator<< (function template)
operator>>

Example

 This section is incomplete
 Reason: no example

External links

* Weisstein,_Eric_W._"Chi-Squared_Distribution." From MathWorld--A Wolfram Web Resource.
* Chi-squared_distribution. From Wikipedia.