libstdc++
std::chi_squared_distribution Class Reference

List of all members.

Classes

Public Types

Public Member Functions

Friends


Detailed Description

A chi_squared_distribution random number distribution.

The formula for the normal probability mass function is $p(x|n) = \frac{x^{(n/2) - 1}e^{-x/2}}{\Gamma(n/2) 2^{n/2}}$


Member Typedef Documentation

The type of the range of the distribution.

Definition at line 2523 of file random.h.


Member Function Documentation

result_type std::chi_squared_distribution::max ( ) const [inline]

Returns the least upper bound value of the distribution.

Definition at line 2596 of file random.h.

result_type std::chi_squared_distribution::min ( ) const [inline]

Returns the greatest lower bound value of the distribution.

Definition at line 2589 of file random.h.

template<typename _UniformRandomNumberGenerator >
result_type std::chi_squared_distribution::operator() ( _UniformRandomNumberGenerator &  __urng) [inline]

Generating functions.

Definition at line 2604 of file random.h.

param_type std::chi_squared_distribution::param ( ) const [inline]

Returns the parameter set of the distribution.

Definition at line 2574 of file random.h.

void std::chi_squared_distribution::param ( const param_type __param) [inline]

Sets the parameter set of the distribution.

Parameters:
__paramThe new parameter set of the distribution.

Definition at line 2582 of file random.h.

void std::chi_squared_distribution::reset ( ) [inline]

Resets the distribution state.

Definition at line 2560 of file random.h.

References std::gamma_distribution::reset().


Friends And Related Function Documentation

template<typename _RealType1 , typename _CharT , typename _Traits >
std::basic_ostream<_CharT, _Traits>& operator<< ( std::basic_ostream< _CharT, _Traits > &  ,
const std::chi_squared_distribution< _RealType1 > &   
) [friend]

Inserts a chi_squared_distribution random number distribution __x into the output stream __os.

Parameters:
__osAn output stream.
__xA chi_squared_distribution random number distribution.
Returns:
The output stream with the state of __x inserted or in an error state.
template<typename _RealType1 >
bool operator== ( const std::chi_squared_distribution< _RealType1 > &  __d1,
const std::chi_squared_distribution< _RealType1 > &  __d2 
) [friend]

Return true if two Chi-squared distributions have the same parameters and the sequences that would be generated are equal.

Definition at line 2624 of file random.h.

template<typename _RealType1 , typename _CharT , typename _Traits >
std::basic_istream<_CharT, _Traits>& operator>> ( std::basic_istream< _CharT, _Traits > &  ,
std::chi_squared_distribution< _RealType1 > &   
) [friend]

Extracts a chi_squared_distribution random number distribution __x from the input stream __is.

Parameters:
__isAn input stream.
__xA chi_squared_distribution random number generator engine.
Returns:
The input stream with __x extracted or in an error state.

The documentation for this class was generated from the following file: