libstdc++
std::discrete_distribution Class Reference

List of all members.

Classes

Public Types

Public Member Functions

Friends


Detailed Description

A discrete_distribution random number distribution.

The formula for the discrete probability mass function is


Member Typedef Documentation

The type of the range of the distribution.

Definition at line 4668 of file random.h.


Member Function Documentation

result_type std::discrete_distribution::max ( ) const [inline]

Returns the least upper bound value of the distribution.

Definition at line 4781 of file random.h.

References std::vector::empty(), and std::vector::size().

result_type std::discrete_distribution::min ( ) const [inline]

Returns the greatest lower bound value of the distribution.

Definition at line 4774 of file random.h.

template<typename _UniformRandomNumberGenerator >
result_type std::discrete_distribution::operator() ( _UniformRandomNumberGenerator &  __urng) [inline]

Generating functions.

Definition at line 4792 of file random.h.

References operator()(), and param().

Referenced by operator()().

param_type std::discrete_distribution::param ( ) const [inline]

Returns the parameter set of the distribution.

Definition at line 4759 of file random.h.

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

void std::discrete_distribution::param ( const param_type __param) [inline]

Sets the parameter set of the distribution.

Parameters:
__paramThe new parameter set of the distribution.

Definition at line 4767 of file random.h.

std::vector<double> std::discrete_distribution::probabilities ( ) const [inline]

Returns the probabilities of the distribution.

Definition at line 4749 of file random.h.

References std::vector::empty().

void std::discrete_distribution::reset ( ) [inline]

Resets the distribution state.

Definition at line 4742 of file random.h.


Friends And Related Function Documentation

template<typename _IntType1 , typename _CharT , typename _Traits >
std::basic_ostream<_CharT, _Traits>& operator<< ( std::basic_ostream< _CharT, _Traits > &  ,
const std::discrete_distribution< _IntType1 > &   
) [friend]

Inserts a discrete_distribution random number distribution __x into the output stream __os.

Parameters:
__osAn output stream.
__xA discrete_distribution random number distribution.
Returns:
The output stream with the state of __x inserted or in an error state.
template<typename _IntType1 , typename _CharT , typename _Traits >
std::basic_istream<_CharT, _Traits>& operator>> ( std::basic_istream< _CharT, _Traits > &  ,
std::discrete_distribution< _IntType1 > &   
) [friend]

Extracts a discrete_distribution random number distribution __x from the input stream __is.

Parameters:
__isAn input stream.
__xA discrete_distribution random number generator engine.
Returns:
The input stream with __x extracted or in an error state.

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