std::chi_squared_distribution< _RealType >(3) | Library Functions Manual | std::chi_squared_distribution< _RealType >(3) |
NAME¶
std::chi_squared_distribution< _RealType > - A chi_squared_distribution random number distribution.
SYNOPSIS¶
Classes¶
struct param_type
Public Types¶
typedef _RealType result_type
Public Member Functions¶
chi_squared_distribution (_RealType __n=_RealType(1))
chi_squared_distribution (const param_type &__p)
template<typename _ForwardIterator , typename _UniformRandomNumberGenerator
> void __generate (_ForwardIterator __f, _ForwardIterator __t,
_UniformRandomNumberGenerator &__urng)
template<typename _ForwardIterator , typename _UniformRandomNumberGenerator
> void __generate (_ForwardIterator __f, _ForwardIterator __t,
_UniformRandomNumberGenerator &__urng, const param_type &__p)
template<typename _UniformRandomNumberGenerator > void __generate
(result_type *__f, result_type *__t,
_UniformRandomNumberGenerator &__urng)
template<typename _UniformRandomNumberGenerator > void __generate
(result_type *__f, result_type *__t,
_UniformRandomNumberGenerator &__urng, const param_type &__p)
result_type max () const
Returns the least upper bound value of the distribution. result_type
min () const
Returns the greatest lower bound value of the distribution. _RealType n
() const
template<typename _UniformRandomNumberGenerator > result_type
operator() (_UniformRandomNumberGenerator &__urng)
Generating functions. template<typename _UniformRandomNumberGenerator >
result_type operator() (_UniformRandomNumberGenerator
&__urng, const param_type &__p)
param_type param () const
Returns the parameter set of the distribution. void param (const
param_type &__param)
Sets the parameter set of the distribution. void reset ()
Resets the distribution state.
Friends¶
template<typename _RealType1 , typename _CharT , typename
_Traits > std::basic_ostream< _CharT, _Traits > &
operator<< (std::basic_ostream< _CharT, _Traits >
&__os, const std::chi_squared_distribution< _RealType1 >
&__x)
Inserts a chi_squared_distribution random number distribution __x into the
output stream __os. bool operator== (const
chi_squared_distribution &__d1, const
chi_squared_distribution &__d2)
Return true if two Chi-squared distributions have the same parameters and the
sequences that would be generated are equal. template<typename _RealType1
, typename _CharT , typename _Traits > std::basic_istream<
_CharT, _Traits > & operator>>
(std::basic_istream< _CharT, _Traits > &__is,
std::chi_squared_distribution< _RealType1 > &__x)
Extracts a chi_squared_distribution random number distribution __x from the
input stream __is.
Detailed Description¶
template<typename _RealType = double>¶
class std::chi_squared_distribution< _RealType >" A chi_squared_distribution random number distribution.
The formula for the normal probability mass function is $p(x|n) = ac{x^{(n/2) - 1}e^{-x/2}}{Gamma(n/2) 2^{n/2}}$
Definition at line 2574 of file random.h.
Member Typedef Documentation¶
template<typename _RealType = double> typedef _RealType std::chi_squared_distribution< _RealType >::result_type¶
The type of the range of the distribution.
Definition at line 2577 of file random.h.
Member Function Documentation¶
template<typename _RealType = double> result_type std::chi_squared_distribution< _RealType >::max () const [inline]¶
Returns the least upper bound value of the distribution.
Definition at line 2664 of file random.h.
References std::numeric_limits< _Tp >::max().
template<typename _RealType = double> result_type std::chi_squared_distribution< _RealType >::min () const [inline]¶
Returns the greatest lower bound value of the distribution.
Definition at line 2657 of file random.h.
template<typename _RealType = double> template<typename _UniformRandomNumberGenerator > result_type std::chi_squared_distribution< _RealType >::operator() (_UniformRandomNumberGenerator & __urng) [inline]¶
Generating functions.
Definition at line 2672 of file random.h.
template<typename _RealType = double> param_type std::chi_squared_distribution< _RealType >::param () const [inline]¶
Returns the parameter set of the distribution.
Definition at line 2637 of file random.h.
template<typename _RealType = double> void std::chi_squared_distribution< _RealType >::param (const param_type & __param) [inline]¶
Sets the parameter set of the distribution.
Parameters:
Definition at line 2645 of file random.h.
References std::gamma_distribution< _RealType >::param().
template<typename _RealType = double> void std::chi_squared_distribution< _RealType >::reset () [inline]¶
Resets the distribution state.
Definition at line 2623 of file random.h.
References std::gamma_distribution< _RealType >::reset().
Friends And Related Function Documentation¶
template<typename _RealType = double> template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_ostream<_CharT, _Traits>& operator<< (std::basic_ostream< _CharT, _Traits > & __os, const std::chi_squared_distribution< _RealType1 > & __x) [friend]¶
Inserts a chi_squared_distribution random number distribution __x into the output stream __os.
Parameters:
__x A chi_squared_distribution random number distribution.
Returns:
template<typename _RealType = double> bool operator== (const chi_squared_distribution< _RealType > & __d1, const chi_squared_distribution< _RealType > & __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 2723 of file random.h.
template<typename _RealType = double> template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_istream<_CharT, _Traits>& operator>> (std::basic_istream< _CharT, _Traits > & __is, std::chi_squared_distribution< _RealType1 > & __x) [friend]¶
Extracts a chi_squared_distribution random number distribution __x from the input stream __is.
Parameters:
__x A chi_squared_distribution random number generator engine.
Returns:
Author¶
Generated automatically by Doxygen for libstdc++ from the source code.
Fri May 24 2024 | libstdc++ |