libstdc++
std::discrete_distribution< _IntType > Class Template Reference

#include <random>

Classes

struct  param_type
 

Public Types

typedef _IntType result_type
 

Public Member Functions

template<typename _InputIterator>
 discrete_distribution (_InputIterator __wbegin, _InputIterator __wend)
 
 discrete_distribution (const param_type &__p)
 
 discrete_distribution (initializer_list< double > __wl)
 
template<typename _Func>
 discrete_distribution (size_t __nw, double __xmin, double __xmax, _Func __fw)
 
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 max () const
 
result_type min () const
 
template<typename _UniformRandomNumberGenerator>
result_type operator() (_UniformRandomNumberGenerator &__urng)
 
template<typename _UniformRandomNumberGenerator>
result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
 
param_type param () const
 
void param (const param_type &__param)
 
std::vector< double > probabilities () const
 
void reset ()
 

Friends

template<typename _IntType1, typename _CharT, typename _Traits>
std::basic_ostream< _CharT, _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &__os, const std::discrete_distribution< _IntType1 > &__x)
 
bool operator== (const discrete_distribution &__d1, const discrete_distribution &__d2)
 
template<typename _IntType1, typename _CharT, typename _Traits>
std::basic_istream< _CharT, _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &__is, std::discrete_distribution< _IntType1 > &__x)
 

Detailed Description

template<typename _IntType = int>
class std::discrete_distribution< _IntType >

A discrete_distribution random number distribution.

This distribution produces random numbers $ i, 0 \leq i < n $, distributed according to the probability mass function $ p(i | p_0, ..., p_{n-1}) = p_i $.

Since
C++11

Definition at line 5546 of file random.h.

Member Typedef Documentation

◆ result_type

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

The type of the range of the distribution.

Definition at line 5553 of file random.h.

Constructor & Destructor Documentation

◆ discrete_distribution() [1/5]

template<typename _IntType = int>
std::discrete_distribution< _IntType >::discrete_distribution ( )
inline

Definition at line 5605 of file random.h.

◆ discrete_distribution() [2/5]

template<typename _IntType = int>
template<typename _InputIterator>
std::discrete_distribution< _IntType >::discrete_distribution ( _InputIterator __wbegin,
_InputIterator __wend )
inline

Definition at line 5610 of file random.h.

◆ discrete_distribution() [3/5]

template<typename _IntType = int>
std::discrete_distribution< _IntType >::discrete_distribution ( initializer_list< double > __wl)
inline

Definition at line 5615 of file random.h.

◆ discrete_distribution() [4/5]

template<typename _IntType = int>
template<typename _Func>
std::discrete_distribution< _IntType >::discrete_distribution ( size_t __nw,
double __xmin,
double __xmax,
_Func __fw )
inline

Definition at line 5620 of file random.h.

◆ discrete_distribution() [5/5]

template<typename _IntType = int>
std::discrete_distribution< _IntType >::discrete_distribution ( const param_type & __p)
inlineexplicit

Definition at line 5626 of file random.h.

Member Function Documentation

◆ __generate() [1/3]

template<typename _IntType = int>
template<typename _ForwardIterator, typename _UniformRandomNumberGenerator>
void std::discrete_distribution< _IntType >::__generate ( _ForwardIterator __f,
_ForwardIterator __t,
_UniformRandomNumberGenerator & __urng )
inline

Definition at line 5695 of file random.h.

◆ __generate() [2/3]

template<typename _IntType = int>
template<typename _ForwardIterator, typename _UniformRandomNumberGenerator>
void std::discrete_distribution< _IntType >::__generate ( _ForwardIterator __f,
_ForwardIterator __t,
_UniformRandomNumberGenerator & __urng,
const param_type & __p )
inline

Definition at line 5702 of file random.h.

◆ __generate() [3/3]

template<typename _IntType = int>
template<typename _UniformRandomNumberGenerator>
void std::discrete_distribution< _IntType >::__generate ( result_type * __f,
result_type * __t,
_UniformRandomNumberGenerator & __urng,
const param_type & __p )
inline

Definition at line 5709 of file random.h.

◆ max()

template<typename _IntType = int>
result_type std::discrete_distribution< _IntType >::max ( ) const
inline

Returns the least upper bound value of the distribution.

Definition at line 5673 of file random.h.

◆ min()

template<typename _IntType = int>
result_type std::discrete_distribution< _IntType >::min ( ) const
inline

Returns the greatest lower bound value of the distribution.

Definition at line 5666 of file random.h.

◆ operator()() [1/2]

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

Generating functions.

Definition at line 5684 of file random.h.

Referenced by operator()().

◆ operator()() [2/2]

template<typename _IntType>
template<typename _UniformRandomNumberGenerator>
discrete_distribution< _IntType >::result_type std::discrete_distribution< _IntType >::operator() ( _UniformRandomNumberGenerator & __urng,
const param_type & __p )

Definition at line 2702 of file bits/random.tcc.

◆ param() [1/2]

template<typename _IntType = int>
param_type std::discrete_distribution< _IntType >::param ( ) const
inline

Returns the parameter set of the distribution.

Definition at line 5651 of file random.h.

◆ param() [2/2]

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

Sets the parameter set of the distribution.

Parameters
__paramThe new parameter set of the distribution.

Definition at line 5659 of file random.h.

◆ probabilities()

template<typename _IntType = int>
std::vector< double > std::discrete_distribution< _IntType >::probabilities ( ) const
inline

Returns the probabilities of the distribution.

Definition at line 5641 of file random.h.

◆ reset()

template<typename _IntType = int>
void std::discrete_distribution< _IntType >::reset ( )
inline

Resets the distribution state.

Definition at line 5634 of file random.h.

Friends And Related Symbol Documentation

◆ operator<<

template<typename _IntType = int>
template<typename _IntType1, typename _CharT, typename _Traits>
std::basic_ostream< _CharT, _Traits > & operator<< ( std::basic_ostream< _CharT, _Traits > & __os,
const std::discrete_distribution< _IntType1 > & __x )
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.

◆ operator==

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

Return true if two discrete distributions have the same parameters.

Definition at line 5719 of file random.h.

◆ operator>>

template<typename _IntType = int>
template<typename _IntType1, typename _CharT, typename _Traits>
std::basic_istream< _CharT, _Traits > & operator>> ( std::basic_istream< _CharT, _Traits > & __is,
std::discrete_distribution< _IntType1 > & __x )
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: