std::uniform_int_distribution(3)

NAME
std::uniform_int_distribution - Uniform discrete distribution for random numbers. A discrete random distribution on the range $[min, max]$ with equal probability throughout the range.

SYNOPSIS

  Classes
struct param_type

  Public Types
typedef _IntType result_type

  Public Member Functions
result_type a () const
result_type b () const
result_type max () const
result_type min () const
template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng)
void param (const param_type &__param)
param_type param () const
void reset ()
uniform_int_distribution (const param_type &__p)
uniform_int_distribution (_IntType __a=0, _IntType __b=9)

Detailed Description

  template<typename _IntType = int> class std::uniform_int_distribution< _IntType >
Uniform discrete distribution for random numbers. A discrete random distribution on the range $[min, max]$ with equal probability throughout the range.

Definition at line 1545 of file bits/random.h.

Member Typedef Documentation

  template<typename _IntType = int> typedef _IntType std::uniform_int_distribution< _IntType >::result_type

The type of the range of the distribution.

Definition at line 1551 of file bits/random.h.

Constructor & Destructor Documentation

  template<typename _IntType = int> std::uniform_int_distribution< _IntType >::uniform_int_distribution (_IntType __a = 0, _IntType __b = 9) [inline, explicit]

Constructs a uniform distribution object.

Definition at line 1586 of file bits/random.h.

Member Function Documentation

  template<typename _IntType = int> result_type std::uniform_int_distribution< _IntType >::max () const [inline]

Returns the inclusive upper bound of the distribution range.

Definition at line 1622 of file bits/random.h.

  template<typename _IntType = int> result_type std::uniform_int_distribution< _IntType >::min () const [inline]

Returns the inclusive lower bound of the distribution range.

Definition at line 1615 of file bits/random.h.

  template<typename _IntType = int> template<typename _UniformRandomNumberGenerator > result_type std::uniform_int_distribution< _IntType >::operator() (_UniformRandomNumberGenerator & __urng, const param_type & __p) [inline]

Gets a uniform random number in the range $[0, n)$.

This function is aimed at use with std::random_shuffle.

Definition at line 1661 of file bits/random.h.

References std::uniform_int_distribution< _IntType >::uniform_int_distribution::param_type::a(), and std::uniform_int_distribution< _IntType >::uniform_int_distribution::param_type::b().

  template<typename _IntType = int> template<typename _UniformRandomNumberGenerator > result_type std::uniform_int_distribution< _IntType >::operator() (_UniformRandomNumberGenerator & __urng) [inline]

Gets a uniformly distributed random number in the range $(min, max)$.

Definition at line 1646 of file bits/random.h.

  template<typename _IntType = int> void std::uniform_int_distribution< _IntType >::param (const param_type & __param) [inline]

Sets the parameter set of the distribution.

Parameters:
    __param The new parameter set of the distribution.

Definition at line 1637 of file bits/random.h.

  template<typename _IntType = int> param_type std::uniform_int_distribution< _IntType >::param () const [inline]

Returns the parameter set of the distribution.

Definition at line 1629 of file bits/random.h.

Referenced by std::operator==(), and std::operator>>().

  template<typename _IntType = int> void std::uniform_int_distribution< _IntType >::reset () [inline]

Resets the distribution state.

Does nothing for the uniform integer distribution.

Definition at line 1601 of file bits/random.h.

Author

Generated automatically by Doxygen for libstdc++ from the source code.