discrete_distribution クラス

  • [アーティクル]

均等幅の区間を含み、各区間に一様確率を含む整数の離散分布を生成します。

構文

template<class IntType = int>
class discrete_distribution
   {
public:
   // types
   typedef IntType result_type;
   struct param_type;

   // constructor and reset functions
   discrete_distribution();
   template <class InputIterator>
   discrete_distribution(InputIterator firstW, InputIterator lastW);
   discrete_distribution(initializer_list<double> weightlist);
   template <class UnaryOperation>
   discrete_distribution(size_t count, double xmin, double xmax, UnaryOperation funcweight);
   explicit discrete_distribution(const param_type& parm);
   void reset();

   // generating functions
   template <class URNG>
   result_type operator()(URNG& gen);
   template <class URNG>
   result_type operator()(URNG& gen, const param_type& parm);

   // property functions
   vector<double> probabilities() const;
   param_type param() const;
   void param(const param_type& parm);
   result_type min() const;
   result_type max() const;
   };

パラメーター

IntType
結果を表す整数型。既定値は int です。 使用可能な型については、「<random>」を参照してください。

解説

この標本分布には均等幅の区間が含まれ、各区間には一様確率が含まれます。 他のサンプリング分布の詳細については、「piecewise_linear_distribution クラス」および「piecewise_constant_distribution クラス」をご覧ください。

次の表は、個々のメンバーに関する記事にリンクしています。

discrete_distribution
param_type

プロパティ関数 vector<double> probabilities() は、生成される整数ごとに個別の確率を返します。

分布クラスとそのメンバーの詳細については、<random> をご覧ください。

例

// compile with: /EHsc /W4
#include <random>
#include <iostream>
#include <iomanip>
#include <string>
#include <map>

using namespace std;

void test(const int s) {

    // uncomment to use a non-deterministic generator
    // random_device rd;
    // mt19937 gen(rd());
    mt19937 gen(1701);

    discrete_distribution<> distr({ 1, 2, 3, 4, 5 });

    cout << endl;
    cout << "min() == " << distr.min() << endl;
    cout << "max() == " << distr.max() << endl;
    cout << "probabilities (value: probability):" << endl;
    vector<double> p = distr.probabilities();
    int counter = 0;
    for (const auto& n : p) {
        cout << fixed << setw(11) << counter << ": " << setw(14) << setprecision(10) << n << endl;
        ++counter;
    }
    cout << endl;

    // generate the distribution as a histogram
    map<int, int> histogram;
    for (int i = 0; i < s; ++i) {
        ++histogram[distr(gen)];
    }

    // print results
    cout << "Distribution for " << s << " samples:" << endl;
    for (const auto& elem : histogram) {
        cout << setw(5) << elem.first << ' ' << string(elem.second, ':') << endl;
    }
    cout << endl;
}

int main()
{
    int samples = 100;

    cout << "Use CTRL-Z to bypass data entry and run using default values." << endl;
    cout << "Enter an integer value for the sample count: ";
    cin >> samples;

    test(samples);
}

Use CTRL-Z to bypass data entry and run using default values.
Enter an integer value for the sample count: 100
min() == 0
max() == 4
probabilities (value: probability):
          0:   0.0666666667
          1:   0.1333333333
          2:   0.2000000000
          3:   0.2666666667
          4:   0.3333333333

Distribution for 100 samples:
    0 :::
    1 ::::::::::::::
    2 ::::::::::::::::::
    3 :::::::::::::::::::::::::::::
    4 ::::::::::::::::::::::::::::::::::::

要件

ヘッダー: <random>

名前空間: std

discrete_distribution::discrete_distribution

分布を作成します。

// default constructor
discrete_distribution();

// construct using a range of weights, [firstW, lastW)
template <class InputIterator>
discrete_distribution(InputIterator firstW, InputIterator lastW);

// construct using an initializer list for range of weights
discrete_distribution(initializer_list<double> weightlist);

// construct using unary operation function
template <class UnaryOperation>
discrete_distribution(size_t count, double low, double high, UnaryOperation weightfunc);

// construct from an existing param_type structure
explicit discrete_distribution(const param_type& parm);

パラメーター

firstW
分布の作成元となるリストの最初の反復子。

lastW
分布の作成元となるリストの最後の反復子 (反復子は最後に空の要素を使用するため、非包含的)。

weightlist
分布の作成元となる initializer_list。

count
分布範囲内にある要素の数。 count==0 の場合は、既定のコンストラクターと同じです (常に 0 を生成します)。

low
分布範囲内の最小値。

high
分布範囲内の最大値。

weightfunc
分布の確率関数を表すオブジェクト。 パラメーターと戻り値の両方が double に変換可能である必要があります。

parm
分布の作成に使用される param_type の構造体。

解説

既定のコンストラクターは、格納された確率値が値 1 である 1 つの要素を持つオブジェクトを構築します。 この結果、常に 0 を生成する分布になります。

パラメーター firstW と lastW のある反復子範囲コンストラクターは、区間シーケンス [firstW, lastW) 全体にわたる反復子から取得された重み値を使って分布オブジェクトを作成します。

weightlist パラメーターを持つ初期化子リスト コンストラクターは、初期化子リスト weightlist の重みで分布オブジェクトを作成します。

count、low、high、weightfunc パラメーターを持つコンストラクターは、以下のルールに基づいて初期化された分布オブジェクトを作成します。

  • count< 1の場合、n = 1 で、このような場合は既定のコンストラクターと同じで、常に 0 を生成します。
  • count> 0 の場合、n = count です。 d = (high - low) / n が 0 より大きい場合、d 個の均等のサブ範囲を使って、各重みが weight[k] = weightfunc(x)のように割り当てられます。ここで、x = low + k * d + d / 2 です (k = 0, ..., n - 1 の場合)。

param_type パラメーター parm を持つコンストラクターは、格納されたパラメーター構造体として parm を使う分布オブジェクトを作成します。

discrete_distribution::param_type

分布のすべてのパラメーターを格納します。

struct param_type {
   typedef discrete_distribution<result_type> distribution_type;
   param_type();

   // construct using a range of weights, [firstW, lastW)
   template <class InputIterator>
   param_type(InputIterator firstW, InputIterator lastW);

   // construct using an initializer list for range of weights
   param_type(initializer_list<double> weightlist);

   // construct using unary operation function
   template <class UnaryOperation>
   param_type(size_t count, double low, double high, UnaryOperation weightfunc);

   std::vector<double> probabilities() const;

   bool operator==(const param_type& right) const;
   bool operator!=(const param_type& right) const;
   };

パラメーター

firstW
分布の作成元となるリストの最初の反復子。

lastW
分布の作成元となるリストの最後の反復子 (反復子は最後に空の要素を使用するため、非包含的)。

weightlist
分布の作成元となる initializer_list。

count
分布範囲内にある要素の数。 count が 0 の場合は、既定のコンストラクターと同じです (常に 0 を生成します)。

low
分布範囲内の最小値。

high
分布範囲内の最大値。

weightfunc
分布の確率関数を表すオブジェクト。 パラメーターと戻り値の両方が double に変換可能である必要があります。

right
このオブジェクトと比較する param_type オブジェクト。

解説

このパラメーター パッケージを operator() に渡して、戻り値を生成できます。

関連項目

<random>