![]() |
Home | Libraries | People | FAQ | More |
boost::random::chi_squared_distribution
// In header: <boost/random/chi_squared_distribution.hpp> template<typename RealType> class chi_squared_distribution { public: // types typedef ; typedef ; // member classes/structs/unions class param_type { public: // types typedef chi_squared_distribution ; // construct/copy/destruct ( = ); // public member functions () ; // friend functions template<typename CharT, typename Traits> (, param_type &); template<typename CharT, typename Traits> (, param_type &); (param_type &, param_type &); (param_type &, param_type &); }; // construct/copy/destruct ( = ); (param_type &); // public member functions template<typename URNG> (); template<typename URNG> (, param_type &) ; () ; () ; () ; param_type () ; (param_type &); (); // friend functions template<typename CharT, typename Traits> (, chi_squared_distribution &); template<typename CharT, typename Traits> (, chi_squared_distribution &); (chi_squared_distribution &, chi_squared_distribution &); (chi_squared_distribution &, chi_squared_distribution &); };
The chi squared distribution is a real valued distribution with one parameter, n
. The distribution produces values > 0.
The distribution function is .
chi_squared_distribution
public
construct/copy/destruct( n = );
Construct a
object. chi_squared_distribution
n
is the parameter of the distribution.
Requires: t >=0 && 0 <= p <= 1
(param_type & param);
Construct an
object from the parameters. chi_squared_distribution
chi_squared_distribution
public member functionstemplate<typename URNG> ( urng);
Returns a random variate distributed according to the chi squared distribution.
template<typename URNG> ( urng, param_type & param) ;
Returns a random variate distributed according to the chi squared distribution with parameters specified by param
.
() ;
Returns the n
parameter of the distribution.
() ;
Returns the smallest value that the distribution can produce.
() ;
Returns the largest value that the distribution can produce.
param_type () ;
Returns the parameters of the distribution.
(param_type & param);
Sets parameters of the distribution.
();
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.
chi_squared_distribution
friend functionstemplate<typename CharT, typename Traits> ( os, chi_squared_distribution & c2d);
Writes the parameters of the distribution to a std::ostream
.
template<typename CharT, typename Traits> ( is, chi_squared_distribution & c2d);
Reads the parameters of the distribution from a std::istream
.
(chi_squared_distribution & lhs, chi_squared_distribution & rhs);
Returns true if the two distributions will produce the same sequence of values, given equal generators.
(chi_squared_distribution & lhs, chi_squared_distribution & rhs);
Returns true if the two distributions could produce different sequences of values, given equal generators.