.TH "std::chi_squared_distribution< _RealType >" 3cxx "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME std::chi_squared_distribution< _RealType > \- A chi_squared_distribution random number distribution\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .SS "Classes" .in +1c .ti -1c .RI "struct \fBparam_type\fP" .br .in -1c .SS "Public Types" .in +1c .ti -1c .RI "\fBtypedef\fP _RealType \fBresult_type\fP" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBchi_squared_distribution\fP (_RealType __n)" .br .ti -1c .RI "\fBchi_squared_distribution\fP (\fBconst\fP \fBparam_type\fP &__p)" .br .ti -1c .RI "template<\fBtypename\fP \fB_ForwardIterator\fP , \fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fB__generate\fP (\fB_ForwardIterator\fP __f, \fB_ForwardIterator\fP __t, \fB_UniformRandomNumberGenerator\fP &\fB__urng\fP)" .br .ti -1c .RI "template<\fBtypename\fP \fB_ForwardIterator\fP , \fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fB__generate\fP (\fB_ForwardIterator\fP __f, \fB_ForwardIterator\fP __t, \fB_UniformRandomNumberGenerator\fP &\fB__urng\fP, \fBconst\fP \fBparam_type\fP &__p)" .br .ti -1c .RI "template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fB__generate\fP (\fBresult_type\fP *__f, \fBresult_type\fP *__t, \fB_UniformRandomNumberGenerator\fP &\fB__urng\fP)" .br .ti -1c .RI "template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBvoid\fP \fB__generate\fP (\fBresult_type\fP *__f, \fBresult_type\fP *__t, \fB_UniformRandomNumberGenerator\fP &\fB__urng\fP, \fBconst\fP \fBparam_type\fP &__p)" .br .ti -1c .RI "\fBresult_type\fP \fBmax\fP () \fBconst\fP" .br .RI "Returns the least upper bound value of the distribution\&. " .ti -1c .RI "\fBresult_type\fP \fBmin\fP () \fBconst\fP" .br .RI "Returns the greatest lower bound value of the distribution\&. " .ti -1c .RI "_RealType \fBn\fP () \fBconst\fP" .br .ti -1c .RI "template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBresult_type\fP \fBoperator()\fP (\fB_UniformRandomNumberGenerator\fP &\fB__urng\fP)" .br .RI "Generating functions\&. " .ti -1c .RI "template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBresult_type\fP \fBoperator()\fP (\fB_UniformRandomNumberGenerator\fP &\fB__urng\fP, \fBconst\fP \fBparam_type\fP &__p)" .br .ti -1c .RI "\fBparam_type\fP \fBparam\fP () \fBconst\fP" .br .RI "Returns the parameter set of the distribution\&. " .ti -1c .RI "\fBvoid\fP \fBparam\fP (\fBconst\fP \fBparam_type\fP &\fB__param\fP)" .br .RI "Sets the parameter set of the distribution\&. " .ti -1c .RI "\fBvoid\fP \fBreset\fP ()" .br .RI "Resets the distribution state\&. " .in -1c .SS "Friends" .in +1c .ti -1c .RI "template<\fBtypename\fP \fB_RealType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator<<\fP (\fBstd::basic_ostream\fP< _CharT, _Traits > &\fB__os\fP, \fBconst\fP \fBstd::chi_squared_distribution\fP< \fB_RealType1\fP > &__x)" .br .RI "Inserts a chi_squared_distribution random number distribution \fC__x\fP into the output stream \fC__os\fP\&. " .ti -1c .RI "bool \fBoperator==\fP (\fBconst\fP \fBchi_squared_distribution\fP &\fB__d1\fP, \fBconst\fP \fBchi_squared_distribution\fP &\fB__d2\fP)" .br .RI "Return true if two Chi-squared distributions have the same parameters and the sequences that would be generated are equal\&. " .ti -1c .RI "template<\fBtypename\fP \fB_RealType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator>>\fP (\fBstd::basic_istream\fP< _CharT, _Traits > &\fB__is\fP, \fBstd::chi_squared_distribution\fP< \fB_RealType1\fP > &__x)" .br .RI "Extracts a chi_squared_distribution random number distribution \fC__x\fP from the input stream \fC__is\fP\&. " .in -1c .SH "Detailed Description" .PP .SS "template<\fBtypename\fP _RealType = double> .br 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) = \frac{x^{(n/2) - 1}e^{-x/2}}{\Gamma(n/2) 2^{n/2}}$ .SH "Member Typedef Documentation" .PP .SS "template<\fBtypename\fP _RealType = double> \fBtypedef\fP _RealType \fBstd::chi_squared_distribution\fP< _RealType >::result_type" The type of the range of the distribution\&. .SH "Member Function Documentation" .PP .SS "template<\fBtypename\fP _RealType = double> \fBresult_type\fP \fBstd::chi_squared_distribution\fP< _RealType >::max () const\fC [inline]\fP" .PP Returns the least upper bound value of the distribution\&. .PP References \fBstd::numeric_limits< _Tp >::max()\fP\&. .SS "template<\fBtypename\fP _RealType = double> \fBresult_type\fP \fBstd::chi_squared_distribution\fP< _RealType >::min () const\fC [inline]\fP" .PP Returns the greatest lower bound value of the distribution\&. .SS "template<\fBtypename\fP _RealType = double> template<\fBtypename\fP \fB_UniformRandomNumberGenerator\fP > \fBresult_type\fP \fBstd::chi_squared_distribution\fP< _RealType >::operator() (\fB_UniformRandomNumberGenerator\fP & __urng)\fC [inline]\fP" .PP Generating functions\&. .SS "template<\fBtypename\fP _RealType = double> \fBparam_type\fP \fBstd::chi_squared_distribution\fP< _RealType >::param () const\fC [inline]\fP" .PP Returns the parameter set of the distribution\&. .SS "template<\fBtypename\fP _RealType = double> \fBvoid\fP \fBstd::chi_squared_distribution\fP< _RealType >::param (\fBconst\fP \fBparam_type\fP & __param)\fC [inline]\fP" .PP Sets the parameter set of the distribution\&. .PP \fBParameters\fP .RS 4 \fI__param\fP The new parameter set of the distribution\&. .RE .PP .PP References \fBstd::gamma_distribution< _RealType >::param()\fP\&. .SS "template<\fBtypename\fP _RealType = double> \fBvoid\fP \fBstd::chi_squared_distribution\fP< _RealType >::reset ()\fC [inline]\fP" .PP Resets the distribution state\&. .PP References \fBstd::gamma_distribution< _RealType >::reset()\fP\&. .SH "Friends And Related Symbol Documentation" .PP .SS "template<\fBtypename\fP _RealType = double> template<\fBtypename\fP \fB_RealType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_ostream\fP< _CharT, _Traits > & \fBoperator\fP<< (\fBstd::basic_ostream\fP< _CharT, _Traits > & __os, \fBconst\fP \fBstd::chi_squared_distribution\fP< \fB_RealType1\fP > & __x)\fC [friend]\fP" .PP Inserts a chi_squared_distribution random number distribution \fC__x\fP into the output stream \fC__os\fP\&. .PP \fBParameters\fP .RS 4 \fI__os\fP An output stream\&. .br \fI__x\fP A chi_squared_distribution random number distribution\&. .RE .PP \fBReturns\fP .RS 4 The output stream with the state of \fC__x\fP inserted or in an error state\&. .RE .PP .SS "template<\fBtypename\fP _RealType = double> bool \fBoperator\fP== (\fBconst\fP \fBchi_squared_distribution\fP< _RealType > & __d1, \fBconst\fP \fBchi_squared_distribution\fP< _RealType > & __d2)\fC [friend]\fP" .PP Return true if two Chi-squared distributions have the same parameters and the sequences that would be generated are equal\&. .SS "template<\fBtypename\fP _RealType = double> template<\fBtypename\fP \fB_RealType1\fP , \fBtypename\fP _CharT , \fBtypename\fP _Traits > \fBstd::basic_istream\fP< _CharT, _Traits > & \fBoperator\fP>> (\fBstd::basic_istream\fP< _CharT, _Traits > & __is, \fBstd::chi_squared_distribution\fP< \fB_RealType1\fP > & __x)\fC [friend]\fP" .PP Extracts a chi_squared_distribution random number distribution \fC__x\fP from the input stream \fC__is\fP\&. .PP \fBParameters\fP .RS 4 \fI__is\fP An input stream\&. .br \fI__x\fP A chi_squared_distribution random number generator engine\&. .RE .PP \fBReturns\fP .RS 4 The input stream with \fC__x\fP extracted or in an error state\&. .RE .PP .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.