std::uniform_int_distribution< _IntType > Class Template Reference
[Uniform Distributions]

Uniform discrete distribution for random numbers. A discrete random distribution on the range $[min, max]$ with equal probability throughout the range. More...

List of all members.

Classes

Public Types

Public Member Functions

Public Attributes


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 1497 of file 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 1504 of file random.h.


Constructor & Destructor Documentation

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

Constructs a uniform distribution object.

Definition at line 1536 of file 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 1573 of file 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 1566 of file random.h.

template<typename _IntType >
template<typename _UniformRandomNumberGenerator >
uniform_int_distribution< _IntType >::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 818 of file random.tcc.

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 1597 of file random.h.

References std::uniform_int_distribution< _IntType >::operator()(), and std::uniform_int_distribution< _IntType >::param().

Referenced by std::uniform_int_distribution< _IntType >::operator()().

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 1588 of file 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 1580 of file random.h.

Referenced by std::uniform_int_distribution< _IntType >::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 1552 of file random.h.


The documentation for this class was generated from the following files:

Generated on 9 Feb 2010 for libstdc++ by  doxygen 1.6.1