cauchy_distribution クラス
コーシー分布を生成します。
構文
template<class RealType = double>
class cauchy_distribution {
public:
// types
typedef RealType result_type;
struct param_type;
// constructor and reset functions
explicit cauchy_distribution(result_type a = 0.0, result_type b = 1.0);
explicit cauchy_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 a() const;
result_type b() const;
param_type param() const;
void param(const param_type& parm);
result_type min() const;
result_type max() const;
};
パラメーター
RealType
浮動小数点の結果の型は、既定では double
です。 使用可能な型については、「<random>」を参照してください。
URNG
Uniform Random Number Generator エンジン。 使用可能な型については、「<random>」を参照してください。
解説
このクラス テンプレートは、コーシー分布に従って分布した、ユーザー指定の浮動小数点型の値または型 double
の値 (指定がない場合) を生成する分布を表します。 次の表は、個々のメンバーに関する記事にリンクしています。
cauchy_distribution
param_type
プロパティ関数 a()
と b()
はそれぞれ、格納されている分布パラメーター a
と b
の値を返します。
プロパティ メンバー param()
は、格納されている分布パラメーター パッケージ param_type
を設定または返します。
メンバー関数の min()
と max()
はそれぞれ、考えられる結果の最小値と最大値を返します。
reset()
メンバー関数は、次回 operator()
を呼び出したときに、その結果が、その前にエンジンから取得された値に左右されないようにするため、キャッシュされている値をすべて破棄します。
operator()
メンバー関数は、現在のパラメーター パッケージと指定したパラメーター パッケージのいずれかから、URNG エンジンに基づいて次に生成された値を返します。
分布クラスとそのメンバーの詳細については、<random> をご覧ください。
コーシー分布の詳細については、Wolfram MathWorld の記事「Cauchy Distribution」(コーシー分布) を参照してください。
例
// compile with: /EHsc /W4
#include <random>
#include <iostream>
#include <iomanip>
#include <string>
#include <map>
void test(const double a, const double b, const int s) {
// uncomment to use a non-deterministic generator
// std::random_device gen;
std::mt19937 gen(1701);
std::cauchy_distribution<> distr(a, b);
std::cout << std::endl;
std::cout << "min() == " << distr.min() << std::endl;
std::cout << "max() == " << distr.max() << std::endl;
std::cout << "a() == " << std::fixed << std::setw(11) << std::setprecision(10) << distr.a() << std::endl;
std::cout << "b() == " << std::fixed << std::setw(11) << std::setprecision(10) << distr.b() << std::endl;
// generate the distribution as a histogram
std::map<double, int> histogram;
for (int i = 0; i < s; ++i) {
++histogram[distr(gen)];
}
// print results
std::cout << "Distribution for " << s << " samples:" << std::endl;
int counter = 0;
for (const auto& elem : histogram) {
std::cout << std::fixed << std::setw(11) << ++counter << ": "
<< std::setw(14) << std::setprecision(10) << elem.first << std::endl;
}
std::cout << std::endl;
}
int main()
{
double a_dist = 0.0;
double b_dist = 1;
int samples = 10;
std::cout << "Use CTRL-Z to bypass data entry and run using default values." << std::endl;
std::cout << "Enter a floating point value for the 'a' distribution parameter: ";
std::cin >> a_dist;
std::cout << "Enter a floating point value for the 'b' distribution parameter (must be greater than zero): ";
std::cin >> b_dist;
std::cout << "Enter an integer value for the sample count: ";
std::cin >> samples;
test(a_dist, b_dist, samples);
}
最初の実行:
Use CTRL-Z to bypass data entry and run using default values.
Enter a floating point value for the 'a' distribution parameter: 0
Enter a floating point value for the 'b' 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
a() == 0.0000000000
b() == 1.0000000000
Distribution for 10 samples:
1: -3.4650392984
2: -2.6369564174
3: -0.0786978867
4: -0.0609632093
5: 0.0589387400
6: 0.0589539764
7: 0.1004592006
8: 1.0965724260
9: 1.4389408122
10: 2.5253154706
2 回目の実行:
Use CTRL-Z to bypass data entry and run using default values.
Enter a floating point value for the 'a' distribution parameter: 0
Enter a floating point value for the 'b' distribution parameter (must be greater than zero): 10
Enter an integer value for the sample count: 10
min() == -1.79769e+308
max() == 1.79769e+308
a() == 0.0000000000
b() == 10.0000000000
Distribution for 10 samples:
1: -34.6503929840
2: -26.3695641736
3: -0.7869788674
4: -0.6096320926
5: 0.5893873999
6: 0.5895397637
7: 1.0045920062
8: 10.9657242597
9: 14.3894081218
10: 25.2531547063
3 回目の実行:
Use CTRL-Z to bypass data entry and run using default values.
Enter a floating point value for the 'a' distribution parameter: 10
Enter a floating point value for the 'b' distribution parameter (must be greater than zero): 10
Enter an integer value for the sample count: 10
min() == -1.79769e+308
max() == 1.79769e+308
a() == 10.0000000000
b() == 10.0000000000
Distribution for 10 samples:
1: -24.6503929840
2: -16.3695641736
3: 9.2130211326
4: 9.3903679074
5: 10.5893873999
6: 10.5895397637
7: 11.0045920062
8: 20.9657242597
9: 24.3894081218
10: 35.2531547063
要件
ヘッダー: <random>
名前空間: std
cauchy_distribution::cauchy_distribution
分布を作成します。
explicit cauchy_distribution(result_type a = 0.0, result_type b = 1.0);
explicit cauchy_distribution(const param_type& parm);
パラメーター
a
a
分布パラメーター。
b
b
分布パラメーター。
parm
分布の作成に使用される param_type
の構造体。
解説
前提条件: 0.0 < b
1 つ目のコンストラクターは、格納されている値 a
と b
にそれぞれ a と b の値を保持するオブジェクトを作成します。
2 つ目のコンストラクターは、格納パラメーターが parm から初期化されるオブジェクトを作成します。 param()
メンバー関数を呼び出すと、既存の分布の現在のパラメーターを取得および設定できます。
cauchy_distribution::param_type
分布のすべてのパラメーターを格納します。
struct param_type {
typedef cauchy_distribution<result_type> distribution_type;
param_type(result_type a = 0.0, result_type b = 1.0);
result_type a() const;
result_type b() const;
bool operator==(const param_type& right) const;
bool operator!=(const param_type& right) const;
};
パラメーター
a
a
分布パラメーター。
b
b
分布パラメーター。
right
このオブジェクトと比較する param_type
オブジェクト。
解説
前提条件: 0.0 < b
この構造体は、インスタンス化時に分布のクラス コンストラクターに渡したり、param()
メンバー関数に渡して、既存の分布の格納されているパラメーターを設定したり、operator()
に渡して、格納されているパラメーターの代わりに使用したりすることができます。