std::uniform_int_distribution< _IntType >

Section: C Library Functions (3)
Updated: Wed Apr 17 2019
Page Index

NAME

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.

SYNOPSIS

Classes

struct param_type

Public Types

typedef _IntType result_type

Public Member Functions

uniform_int_distribution (_IntType __a=0, _IntType __b=std::numeric_limits< _IntType >::max())
Constructs a uniform distribution object.
uniform_int_distribution (const param_type &__p)

template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)

template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > void __generate (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const param_type &__p)

template<typename _UniformRandomNumberGenerator > void __generate (result_type *__f, result_type *__t, _UniformRandomNumberGenerator &__urng, const param_type &__p)

result_type a () const

result_type b () const

result_type max () const
Returns the inclusive upper bound of the distribution range.
result_type min () const
Returns the inclusive lower bound of the distribution range.
template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng)
Generating functions.
template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)

param_type param () const
Returns the parameter set of the distribution.
void param (const param_type &__param)
Sets the parameter set of the distribution.
void reset ()
Resets the distribution state.

Friends

bool operator== (const uniform_int_distribution &__d1, const uniform_int_distribution &__d2)
Return true if two uniform integer distributions have the same parameters.

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 58 of file uniform_int_dist.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 61 of file uniform_int_dist.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 105 of file uniform_int_dist.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 157 of file uniform_int_dist.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 150 of file uniform_int_dist.h.

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

Generating functions.

Definition at line 165 of file uniform_int_dist.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 135 of file uniform_int_dist.h.

Referenced by std::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 143 of file uniform_int_dist.h.

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 121 of file uniform_int_dist.h.

Friends And Related Function Documentation

template<typename _IntType = int> bool operator== (const uniform_int_distribution< _IntType > & __d1, const uniform_int_distribution< _IntType > & __d2) [friend]

Return true if two uniform integer distributions have the same parameters.

Definition at line 200 of file uniform_int_dist.h.

Author

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