lognormal_distribution クラス

対数正規分布を生成します。

構文

template <class RealType = double>
class lognormal_distribution
   {
public:
   // types
   typedef RealType result_type;
   struct param_type;
   // constructor and reset functions
   explicit lognormal_distribution(result_type m = 0.0, result_type s = 1.0);
   explicit lognormal_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
   result_type m() const;
   result_type s() const;
   param_type param() const;
   void param(const param_type& parm);
   result_type min() const;
   result_type max() const;
   };

パラメーター

RealType
浮動小数点の結果の型は、既定では double です。 使用可能な型については、「<random>」を参照してください。

解説

クラス テンプレートは、ユーザー指定の整数型、または何も指定されない場合は double 型で、対数正規分布に従って分布されている値を生成する分布について説明します。 次の表は、個々のメンバーに関する記事にリンクしています。

lognormal_distribution
param_type

プロパティ関数 m() および s() は、格納されている分布パラメーター m および s に対してそれぞれの値を返します。

プロパティ メンバー param() は、格納されている分布パラメーター パッケージ param_type を設定または返します。

メンバー関数の min() と max() はそれぞれ、考えられる結果の最小値と最大値を返します。

reset() メンバー関数は、次回 operator() を呼び出したときに、その結果が、その前にエンジンから取得された値に左右されないようにするため、キャッシュされている値をすべて破棄します。

operator() メンバー関数は、現在のパラメーター パッケージと指定したパラメーター パッケージのいずれかから、URNG エンジンに基づいて次に生成された値を返します。

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

LogNormal 分布の詳細については、Wolfram MathWorld の記事「LogNormal Distribution」をご覧ください。

例

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

using namespace std;

void test(const double m, const double s, const int samples) {

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

    lognormal_distribution<> distr(m, s);

    cout << endl;
    cout << "min() == " << distr.min() << endl;
    cout << "max() == " << distr.max() << endl;
    cout << "m() == " << fixed << setw(11) << setprecision(10) << distr.m() << endl;
    cout << "s() == " << fixed << setw(11) << setprecision(10) << distr.s() << endl;

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

    // print results
    cout << "Distribution for " << samples << " samples:" << endl;
    int counter = 0;
    for (const auto& elem : histogram) {
        cout << fixed << setw(11) << ++counter << ": "
            << setw(14) << setprecision(10) << elem.first << endl;
    }
    cout << endl;
}

int main()
{
    double m_dist = 1;
    double s_dist = 1;
    int samples = 10;

    cout << "Use CTRL-Z to bypass data entry and run using default values." << endl;
    cout << "Enter a floating point value for the 'm' distribution parameter: ";
    cin >> m_dist;
    cout << "Enter a floating point value for the 's' distribution parameter (must be greater than zero): ";
    cin >> s_dist;
    cout << "Enter an integer value for the sample count: ";
    cin >> samples;

    test(m_dist, s_dist, samples);
}

Use CTRL-Z to bypass data entry and run using default values.
Enter a floating point value for the 'm' distribution parameter: 0
Enter a floating point value for the 's' distribution parameter (must be greater than zero): 1
Enter an integer value for the sample count: 10

min() == -1.79769e+308
max() == 1.79769e+308
m() == 0.0000000000
s() == 1.0000000000
Distribution for 10 samples:
    1: 0.3862809339
    2: 0.4128865601
    3: 0.4490576787
    4: 0.4862035428
    5: 0.5930607126
    6: 0.8190778771
    7: 0.8902379317
    8: 2.8332911667
    9: 5.1359445565
    10: 5.4406507912

要件

ヘッダー: <random>

名前空間: std

lognormal_distribution::lognormal_distribution

分布を作成します。

explicit lognormal_distribution(RealType m = 0.0, RealType s = 1.0);
explicit lognormal_distribution(const param_type& parm);

パラメーター

m
m 分布パラメーター。

s
s 分布パラメーター。

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

解説

前提条件: 0.0 < s

1 つ目のコンストラクターは、格納されている値 m と s にそれぞれ m と s の値を保持するオブジェクトを作成します。

2 つ目のコンストラクターは、格納パラメーターが parm から初期化されるオブジェクトを作成します。 param() メンバー関数を呼び出すと、既存の分布の現在のパラメーターを取得および設定できます。

lognormal_distribution::param_type

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

struct param_type {
   typedef lognormal_distribution<result_type> distribution_type;
   param_type(result_type m = 0.0, result_type s = 1.0);
   result_type m() const;
   result_type s() const;

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

パラメーター

m
m 分布パラメーター。

s
s 分布パラメーター。

right
比較に使用される param_type 構造体。

解説

前提条件: 0.0 < s

この構造体は、インスタンス化時に分布のクラス コンストラクターに渡したり、param() メンバー関数に渡して、既存の分布の格納されているパラメーターを設定したり、operator() に渡して、格納されているパラメーターの代わりに使用したりすることができます。

関連項目

<random>