Class template discrete_distribution . Boost , The Boost C++ Libraries BoostBook Documentation Subset , Reference

Class template discrete_distribution

boost::random::discrete_distribution

Synopsis

// In header: <boost/random/discrete_distribution.hpp>
template<typename IntType = int, typename WeightType = double> 
class discrete_distribution {
public:
  // types
  typedef WeightType input_type; 
  typedef IntType    result_type;
  // member classes/structs/unions
  class param_type {
  public:
    // types
    typedef discrete_distribution distribution_type;
    // construct/copy/destruct
    param_type();
    template<typename Iter> param_type(Iter, Iter);
    param_type(const std::initializer_list< WeightType > &);
    template<typename Range> explicit param_type(const Range &);
    template<typename Func> param_type(std::size_t, double, double, Func);
    // public member functions
    std::vector< WeightType > probabilities() const;
    // friend functions
    template<typename CharT, typename Traits> 
      friend std::basic_ostream< CharT, Traits > & 
      operator<<(std::basic_ostream< CharT, Traits > &, const param_type &);
    template<typename CharT, typename Traits> 
      friend std::basic_istream< CharT, Traits > & 
      operator>>(std::basic_istream< CharT, Traits > &, const param_type &);
    friend bool operator==(const param_type &, const param_type &);
    friend bool operator!=(const param_type &, const param_type &);
  };
  // construct/copy/destruct
  discrete_distribution();
  template<typename Iter> discrete_distribution(Iter, Iter);
  discrete_distribution(std::initializer_list< WeightType >);
  template<typename Range> explicit discrete_distribution(const Range &);
  template<typename Func> 
    discrete_distribution(std::size_t, double, double, Func);
  explicit discrete_distribution(const param_type &);
  // public member functions
  template<typename URNG> IntType operator()(URNG &) const;
  template<typename URNG> IntType operator()(URNG &, const param_type &) const;
  result_type min() const;
  result_type max() const;
  std::vector< WeightType > probabilities() const;
  param_type param() const;
  void param(const param_type &);
  void reset();
  // friend functions
  template<typename CharT, typename Traits> 
    friend std::basic_ostream< CharT, Traits > & 
    operator<<(std::basic_ostream< CharT, Traits > &, 
               const discrete_distribution &);
  template<typename CharT, typename Traits> 
    friend std::basic_istream< CharT, Traits > & 
    operator>>(std::basic_istream< CharT, Traits > &, 
               const discrete_distribution &);
  friend bool operator==(const discrete_distribution &, 
                         const discrete_distribution &);
  friend bool operator!=(const discrete_distribution &, 
                         const discrete_distribution &);
};

Description

Класс<discrete_distribution>моделируетслучайное распределение. Он производит целые числа в диапазоне [0, n], причем вероятность получения каждого значения определяется параметрами распределения.

`discrete_distribution` public construct/copy/destruct

<
```
discrete_distribution();
```
>
Создает новыйобъекти.
<
```
template<typenameIter>discrete_distribution(Iterfirst,Iterlast);
```
>
Конструирует<discrete_distribution>из диапазона итераторов. Если<first>==<last>, что эквивалентно по умолчанию конструктору. В противном случае значения диапазона представляют собой веса для возможных значений распределения.
<
```
discrete_distribution(std::initializer_list<WeightType>wl);
```
>
Построение<discrete_distribution>из<std::initializer_list>. Если<initializer_list>пусто, то это эквивалентно по умолчанию конструктору. В противном случае значения<initializer_list>представляют собой веса для возможных значений распределения. Например, учитывая распределение
<
```
discrete_distribution<>dist{1,4,5};
```
>
Вероятность 0 равна 1/10, вероятность 1 равна 2/5, вероятность 2 равна 1/2 и никакие другие значения невозможны.
<
```
template<typenameRange>explicitdiscrete_distribution(constRange&range);
```
>
Сооружает<discrete_distribution>из буста. Диапазон. Если диапазон пуст, эквивалентен конструктору по умолчанию. В противном случае значения диапазона представляют собой веса для возможных значений распределения.
<
```
template<typenameFunc>
 discrete_distribution(std::size_tnw,doublexmin,doublexmax,Funcfw);
```
>
Конструирует<discrete_distribution>, приближенное к функции. Если nw равно нулю, то это эквивалентно конструктору по умолчанию. В противном случае диапазон распределения равен [0, nw], а веса можно найти, называя fw с значениями, равномерно распределенными междуи, где.
<
```
explicitdiscrete_distribution(constparam_type&param);
```
>
Конструирует<discrete_distribution>из его параметров.

`discrete_distribution` public member functions

<
```
template<typenameURNG>IntTypeoperator()(URNG&urng)const;
```
>
Возвращает значение, распределенное в соответствии с параметрами<discrete_distribution>
.
<
```
template<typenameURNG>
 IntTypeoperator()(URNG&urng,constparam_type&param)const;
```
>
Возвращает значение, распределенное по параметрам, указанным парам.
<
```
result_typemin()const;
```
>
Возвращает наименьшее значение, которое может произвести распределение.
<
```
result_typemax()const;
```
>
Возвращает наибольшую ценность, которую может произвести распределение.
<
```
std::vector<WeightType>probabilities()const;
```
>
Возвращает вектор, содержащий вероятности каждого значения распределения. Например, учитывая
<
```
discrete_distribution<>dist={1,4,5};
std::vector<double>p=dist.param();
```
>
вектор, p будет содержать {0.1, 0.4, 0.5}.
Если<WeightType>является интегралом, то весы будут возвращены без изменений.
<
```
param_typeparam()const;
```
>
Возвращает параметры распределения.
<
```
voidparam(constparam_type&param);
```
>
Устанавливает параметры распределения.
<
```
voidreset();
```
>
Эффекты: Последующее использование распределения не зависит от значений, произведенных каким-либо двигателем до вызова сброса.

`discrete_distribution` friend functions

template<typenameCharT,typenameTraits>
 friendstd::basic_ostream<CharT,Traits>&
 operator<<(std::basic_ostream<CharT,Traits>&os,
            constdiscrete_distribution&dd);

Пишет распределение<std::ostream>

template<typenameCharT,typenameTraits>
 friendstd::basic_istream<CharT,Traits>&
 operator>>(std::basic_istream<CharT,Traits>&is,
            constdiscrete_distribution&dd);

Читает распределение от<std::istream>

<
```
friendbooloperator==(constdiscrete_distribution&lhs,
                      constdiscrete_distribution&rhs);
```
>
Возвращается истинно, если два распределения возвращают одну и ту же последовательность значений, когда переданы равные генераторы.
<
```
friendbooloperator!=(constdiscrete_distribution&lhs,
                      constdiscrete_distribution&rhs);
```
>
Возвращается истинно, если два распределения могут возвращать разные последовательности значений, когда переданы равные генераторы.

Статья Class template discrete_distribution раздела The Boost C++ Libraries BoostBook Documentation Subset Reference может быть полезна для разработчиков на c++ и boost.

Class template discrete_distribution

Boost , The Boost C++ Libraries BoostBook Documentation Subset , Reference

Boost C++ Libraries

Class template discrete_distribution

Synopsis

Description

discrete_distribution public construct/copy/destruct

discrete_distribution public member functions

discrete_distribution friend functions

`discrete_distribution` public construct/copy/destruct

`discrete_distribution` public member functions

`discrete_distribution` friend functions