![]() |
Home | Libraries | People | FAQ | More |
boost::random::uniform_int_distribution
// In header: <boost/random/uniform_int_distribution.hpp> template<typename IntType = int> class uniform_int_distribution { public: // types typedef IntType ; typedef IntType ; // member classes/structs/unions class param_type { public: // types typedef uniform_int_distribution ; // construct/copy/destruct (IntType = , IntType = (IntType >::); // public member functions IntType () ; IntType () ; // 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 (IntType = , IntType = (IntType >::); (const param_type &); // public member functions IntType () ; IntType () ; 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 uniform_int_distribution &); template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > &, const uniform_int_distribution &); bool (const uniform_int_distribution &, const uniform_int_distribution &); bool (const uniform_int_distribution &, const uniform_int_distribution &); };
The class template uniform_int_distribution models a random distribution . On each invocation, it returns a random integer value uniformly distributed in the set of integers {min, min+1, min+2, ..., max}.
The template parameter IntType shall denote an integer-like value type.
uniform_int_distribution
public
construct/copy/destruct(IntType min = , IntType max = (IntType >::);
Constructs a uniform_int_distribution
. min
and max
are the parameters of the distribution.
Requires: min <= max
(const param_type & param);
Constructs a uniform_int_distribution
from its parameters.
uniform_int_distribution
public member functionsIntType () ;
Returns the minimum value of the distribution
IntType () ;
Returns the maximum value of the distribution
IntType () ;
Returns the minimum value of the distribution
IntType () ;
Returns the maximum value of the distribution
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 an integer uniformly distributed in the range [min, max].
template<typename Engine> result_type (Engine & eng, const param_type & param) ;
Returns an integer uniformly distributed in the range [param.a(), param.b()].
uniform_int_distribution
friend functionstemplate<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > & os, const uniform_int_distribution & ud);
Writes the distribution to a std::ostream
.
template<typename CharT, typename Traits> CharT, Traits > & (CharT, Traits > & is, const uniform_int_distribution & ud);
Reads the distribution from a std::istream
.
bool (const uniform_int_distribution & lhs, const uniform_int_distribution & rhs);
Returns true if the two distributions will produce identical sequences of values given equal generators.
bool (const uniform_int_distribution & lhs, const uniform_int_distribution & rhs);
Returns true if the two distributions may produce different sequences of values given equal generators.