...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
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 input_type; typedef IntType result_type; // member classes/structs/unions class param_type { public: // types typedef uniform_int_distribution distribution_type; // construct/copy/destruct explicit param_type(IntType = 0, IntType = (std::numeric_limits< IntType >::max)()); // public member functions IntType a() const; IntType b() const; // friend functions template<typename CharT, typename Traits> std::basic_ostream< CharT, Traits > & operator<<(std::basic_ostream< CharT, Traits > &, const param_type &); template<typename CharT, typename Traits> std::basic_istream< CharT, Traits > & operator>>(std::basic_istream< CharT, Traits > &, const param_type &); bool operator==(const param_type &, const param_type &); bool operator!=(const param_type &, const param_type &); }; // construct/copy/destruct explicit uniform_int_distribution(IntType = 0, IntType = (std::numeric_limits< IntType >::max)()); explicit uniform_int_distribution(const param_type &); // public member functions IntType min() const; IntType max() const; IntType a() const; IntType b() const; param_type param() const; void param(const param_type &); void reset(); template<typename Engine> result_type operator()(Engine &) const; template<typename Engine> result_type operator()(Engine &, const param_type &) const; // friend functions template<typename CharT, typename Traits> std::basic_ostream< CharT, Traits > & operator<<(std::basic_ostream< CharT, Traits > &, const uniform_int_distribution &); template<typename CharT, typename Traits> std::basic_istream< CharT, Traits > & operator>>(std::basic_istream< CharT, Traits > &, const uniform_int_distribution &); bool operator==(const uniform_int_distribution &, const uniform_int_distribution &); bool operator!=(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/destructexplicit uniform_int_distribution(IntType min = 0, IntType max = (std::numeric_limits< IntType >::max)());
Constructs a uniform_int_distribution
. min
and max
are the parameters of the distribution.
Requires: min <= max
explicit uniform_int_distribution(const param_type & param);
Constructs a uniform_int_distribution
from its parameters.
uniform_int_distribution
public member functionsIntType min() const;
Returns the minimum value of the distribution
IntType max() const;
Returns the maximum value of the distribution
IntType a() const;
Returns the minimum value of the distribution
IntType b() const;
Returns the maximum value of the distribution
param_type param() const;
Returns the parameters of the distribution.
void param(const param_type & param);
Sets the parameters of the distribution.
void reset();
Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset.
template<typename Engine> result_type operator()(Engine & eng) const;
Returns an integer uniformly distributed in the range [min, max].
template<typename Engine> result_type operator()(Engine & eng, const param_type & param) const;
Returns an integer uniformly distributed in the range [param.a(), param.b()].
uniform_int_distribution
friend functionstemplate<typename CharT, typename Traits> std::basic_ostream< CharT, Traits > & operator<<(std::basic_ostream< CharT, Traits > & os, const uniform_int_distribution & ud);
Writes the distribution to a std::ostream
.
template<typename CharT, typename Traits> std::basic_istream< CharT, Traits > & operator>>(std::basic_istream< CharT, Traits > & is, const uniform_int_distribution & ud);
Reads the distribution from a std::istream
.
bool operator==(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 operator!=(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.