![]() |
Home | Libraries | People | FAQ | More |
boost::random::gamma_distribution
// In header: <boost/random/gamma_distribution.hpp> template<typename RealType> class gamma_distribution { public: // types typedef ; typedef ; // member classes/structs/unions class param_type { public: // types typedef gamma_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 () ; () ; () ; () ; param_type () ; (param_type &); (); template<typename Engine> (); template<typename URNG> (, param_type &) ; // friend functions template<typename CharT, typename Traits> (, gamma_distribution &); template<typename CharT, typename Traits> (, gamma_distribution &); (gamma_distribution &, gamma_distribution &); (gamma_distribution &, gamma_distribution &); };
The gamma distribution is a continuous distribution with two parameters alpha and beta. It produces values > 0.
It has .
gamma_distribution
public
construct/copy/destruct( alpha = , beta = );
Creates a new gamma_distribution
with parameters "alpha" and "beta".
Requires: alpha > 0 && beta > 0
(param_type & param);
Constructs a
from its parameters. gamma_distribution
gamma_distribution
public member functions() ;
Returns the "alpha" paramter of the distribution.
() ;
Returns the "beta" parameter of the distribution.
() ;
Returns the smallest value that the distribution can produce.
() ;
param_type () ;
Returns the parameters of the distribution.
(param_type & param);
Sets the parameters of the distribution.
();
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.
template<typename Engine> ( eng);
Returns a random variate distributed according to the gamma distribution.
template<typename URNG> ( urng, param_type & param) ;
gamma_distribution
friend functionstemplate<typename CharT, typename Traits> ( os, gamma_distribution & gd);
Writes a
to a gamma_distribution
std::ostream
.
template<typename CharT, typename Traits> ( is, gamma_distribution & gd);
Reads a
from a gamma_distribution
std::istream
.
(gamma_distribution & lhs, gamma_distribution & rhs);
Returns true if the two distributions will produce identical sequences of random variates given equal generators.
(gamma_distribution & lhs, gamma_distribution & rhs);
Returns true if the two distributions can produce different sequences of random variates, given equal generators.