Manpages - std_discrete_distribution.3

Table of Contents

NAME

std::discrete_distribution< _IntType > - A discrete_distribution random number distribution.

SYNOPSIS


#include <random.h>

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
Returns the least upper bound value of the distribution.

result_type min () const
Returns the greatest lower bound value of the distribution.

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.

std::vector*< double > *probabilities () const
Returns the probabilities of the distribution.

void reset ()
Resets the distribution state.

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)
Inserts a discrete_distribution random number distribution __x into the output stream __os.

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

template<typename _IntType1 , typename _CharT , typename _Traits > std::basic_istream*< _CharT, _Traits > & *operator>> (*std::basic_istream*< _CharT, _Traits > &__is, *std::discrete_distribution*< _IntType1 > &__x)
Extracts a discrete_distribution random number distribution __x from the input stream __is.

Detailed Description

“template<typename _IntType = int>


class std::discrete_distribution< _IntType >“A discrete_distribution random number distribution.

The formula for the discrete probability mass function is

Definition at line 5279 of file random.h.

Member Typedef Documentation

template<typename _IntType = int> typedef _IntType

std::discrete_distribution*< _IntType >::*result_type The type of the range of the distribution.

Definition at line 5286 of file random.h.

Constructor & Destructor Documentation

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

_IntType >::*discrete_distribution* ()= [inline]= Definition at line 5336 of file random.h.

template<typename _IntType = int> template<typename _InputIterator >

std::discrete_distribution*< _IntType >::*discrete_distribution (_InputIterator __wbegin, _InputIterator __wend)= [inline]= Definition at line 5341 of file random.h.

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

_IntType >::*discrete_distribution* (initializer_list*< double > __wl)= [inline]= Definition at line *5346 of file random.h.

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

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

_IntType >::*discrete_distribution* (const param_type & __p)= [inline]=, = [explicit]= Definition at line 5357 of file random.h.

Member Function Documentation

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

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

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

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

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

template<typename _IntType = int> template<typename

_UniformRandomNumberGenerator > result_type *std::discrete_distribution*< _IntType >::operator() (_UniformRandomNumberGenerator & __urng)= [inline]= Generating functions.

Definition at line 5415 of file random.h.

References std::discrete_distribution< _IntType >::operator()().

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

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 2698 of file bits/random.tcc.

template<typename _IntType = int> param_type

*std::discrete_distribution*< _IntType >::param () const= [inline]= Returns the parameter set of the distribution.

Definition at line 5382 of file random.h.

template<typename _IntType = int> void *std::discrete_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 5390 of file random.h.

template<typename _IntType = int> *std::vector*< double >

*std::discrete_distribution*< _IntType >::probabilities () const= [inline]= Returns the probabilities of the distribution.

Definition at line 5372 of file random.h.

template<typename _IntType = int> void *std::discrete_distribution*<

_IntType >::reset ()= [inline]= Resets the distribution state.

Definition at line 5365 of file random.h.

Friends And Related Function Documentation

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

__os An output stream.
__x A discrete_distribution random number distribution.

Returns

The output stream with the state of __x inserted or in an error state.

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

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

__is An input stream.
__x A discrete_distribution random number generator engine.

Returns

The input stream with __x extracted or in an error state.

Author

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

Author: dt

Created: 2022-02-20 Sun 19:31