![]() |
Home | Libraries | People | FAQ | More |
boost::random::geometric_distribution
// In header: <boost/random/geometric_distribution.hpp> template<typename IntType = int, typename RealType = double> class geometric_distribution { public: // types typedef RealType ; typedef IntType ; // member classes/structs/unions class param_type { public: // types typedef geometric_distribution ; // construct/copy/destruct (RealType = ); // public member functions RealType () ; // friend functions template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const param_type &); template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const param_type &); bool (const param_type &, const param_type &); bool (const param_type &, const param_type &); }; // construct/copy/destruct (const RealType & = ); (const param_type &); // public member functions RealType () ; IntType () ; IntType () ; param_type () ; void (const param_type &); void (); template<typename Engine> result_type (Engine &) ; template<typename Engine> result_type (Engine &, const param_type &) ; // friend functions template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const geometric_distribution &); template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const geometric_distribution &); bool (const geometric_distribution &, const geometric_distribution &); bool (const geometric_distribution &, const geometric_distribution &); };
An instantiation of the class template geometric_distribution
models a random distribution . The distribution produces positive integers which are the number of bernoulli trials with probability p
required to get one that fails.
For the geometric distribution, .
![]() |
Warning |
---|---|
This distribution has been updated to match the C++ standard. Its behavior has changed from the original boost::geometric_distribution. A backwards compatible wrapper is provided in namespace boost. |
geometric_distribution
public
construct/copy/destruct(const RealType & p = );
Contructs a new geometric_distribution
with the paramter p
.
Requires: 0 < p < 1
(const param_type & param);
Constructs a new geometric_distribution
from its parameters.
geometric_distribution
public member functionsRealType () ;
Returns: the distribution parameter p
IntType () ;
Returns the smallest value that the distribution can produce.
IntType () ;
Returns the largest value that the distribution can produce.
param_type () ;
Returns the parameters of the distribution.
void (const param_type & param);
Sets the parameters of the distribution.
void ();
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.
template<typename Engine> result_type (Engine & eng) ;
Returns a random variate distributed according to the geometric_distribution
.
template<typename Engine> result_type (Engine & eng, const param_type & param) ;
Returns a random variate distributed according to the geometric distribution with parameters specified by param.
geometric_distribution
friend functionstemplate<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > & os, const geometric_distribution & gd);
Writes the distribution to a std::ostream
.
template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > & is, const geometric_distribution & gd);
Reads the distribution from a std::istream
.
bool (const geometric_distribution & lhs, const geometric_distribution & rhs);
Returns true if the two distributions will produce identical sequences of values given equal generators.
bool (const geometric_distribution & lhs, const geometric_distribution & rhs);
Returns true if the two distributions may produce different sequences of values given equal generators.