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