std::subtract_with_carry_engine

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

数値ライブラリ

共通の数学関数
数学特殊関数 (C++17)
数学定数 (C++20)
基本的な線形代数アルゴリズム (C++26)
データ並列型 (SIMD) (C++26)
浮動小数点環境 (C++11)
複素数
数値配列 (valarray)
擬似乱数生成
ビット操作 (C++20)
因数操作
gcd (C++17)	lcm (C++17)
補間
midpoint (C++20)	lerp (C++20)
飽和演算
add_sat (C++26) sub_sat (C++26) saturate_cast (C++26)	mul_sat (C++26) div_sat (C++26)
汎用数値演算
iota (C++11) ranges::iota (C++23) accumulate inner_product adjacent_difference    partial_sum	reduce (C++17) transform_reduce (C++17) inclusive_scan (C++17) exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)

 

擬似乱数生成

一様乱数ビット生成器   uniform_random_bit_generator (C++20) 乱数エンジン linear_congruential_engine (C++11) mersenne_twister_engine (C++11) subtract_with_carry_engine (C++11) philox_engine (C++26) 乱数エンジンアダプタ discard_block_engine (C++11) independent_bits_engine (C++11) shuffle_order_engine (C++11) 定義済み乱数生成器 非決定論的乱数 random_device (C++11) ユーティリティ generate_canonical (C++11) seed_seq (C++11) 乱数アルゴリズム ranges::generate_random (C++26) C言語の乱数ライブラリ rand    srand    RAND_MAX

乱数分布 一様分布 uniform_int_distribution (C++11) uniform_real_distribution (C++11) generate_canonical (C++11) ベルヌーイ分布 bernoulli_distribution (C++11) binomial_distribution (C++11) negative_binomial_distribution (C++11) geometric_distribution (C++11) ポアソン分布 poisson_distribution (C++11) exponential_distribution (C++11) gamma_distribution (C++11) weibull_distribution (C++11) extreme_value_distribution (C++11) 正規分布 normal_distribution (C++11) lognormal_distribution (C++11) chi_squared_distribution (C++11) cauchy_distribution (C++11) fisher_f_distribution (C++11) student_t_distribution (C++11) 標本分布 discrete_distribution (C++11) piecewise_constant_distribution (C++11) piecewise_linear_distribution (C++11)

 

std::subtract_with_carry_engine

メンバ関数

subtract_with_carry_engine::subtract_with_carry_engine

subtract_with_carry_engine::seed

生成

subtract_with_carry_engine::operator()

subtract_with_carry_engine::discard

特性

subtract_with_carry_engine::min

subtract_with_carry_engine::max

非メンバ関数

operator==operator!= (C++11)(C++11)(C++20まで)

operator<<operator>> (C++11)(C++11)

 

ヘッダー <random> で定義
template<     class UIntType,     std::size_t w, std::size_t s, std::size_t r > class subtract_with_carry_engine;		(C++11以降)

は、subtract with carryアルゴリズムを使用する乱数エンジンのひとつです。

テンプレートパラメータ

UIntType	-	ジェネレータによって生成される結果の型。これがunsigned short、unsigned int、unsigned long、またはunsigned long longのいずれでもない場合、動作は未定義です。
w	-	状態シーケンスのワードサイズ（ビット単位）
s	-	短いラグ
r	-	長いラグ

もし w が [1, std::numeric_limits<UIntType>::digits] になく、または s が [1, r) にない場合、プログラムは形式エラーとなります。

ジェネレータのプロパティ

subtract_with_carry_engine の状態のサイズは \(\scriptsize O(r)\)O(r) であり、それぞれ2つの部分から構成されます。

• 整数値 X のシーケンスで、r 個の値があり、各値は [​0​, 2w
) の範囲にあります。
• 整数 c（「キャリー」として知られる）で、その値は ​0​ または 1 です。

\(\scriptsize X_j\)Xj を X の \(\scriptsize j\mod r\)j mod r番目の値（0から始まる）とすると、subtract_with_carry_engine の遷移アルゴリズム（\(\scriptsize TA(x_i)\)TA(xi)）は次のように定義されます。

1. Y を \(\scriptsize X_{i-s}-X_{i-r}-c\)Xi-s-Xi-r-c とします。
2. y を \(\scriptsize Y\mod 2^w\)Y mod 2w
   とし、X_i を y に設定します。
3. もし Y が負であれば、c を 1 に設定し、そうでなければ c を ​0​ に設定します。

subtract_with_carry_engine の生成アルゴリズムは \(\scriptsize GA(x_i) = y\)GA(xi) = y であり、ここで y は遷移アルゴリズムのステップ2で生成された値です。

事前定義された特殊化

以下の特殊化は、一般的に使用される2つのパラメータセットを持つ乱数エンジンを定義します。

ヘッダー <random> で定義
型	定義
ranlux24_base (C++11)	std::subtract_with_carry_engine<std::uint_fast32_t, 24, 10, 24>
ranlux48_base (C++11)	std::subtract_with_carry_engine<std::uint_fast64_t, 48, 5, 12>

ネストされた型

型	定義
result_type	UIntType

データメンバー

constexpr std::size_t word_size [static]	w (公開静的メンバ定数)
constexpr std::size_t short_lag [static]	s (公開静的メンバ定数)
constexpr std::size_t long_lag [static]	r (公開静的メンバ定数)
constexpr std::uint_least32_t default_seed [static]	19780503u (公開静的メンバ定数)

メンバ関数

構築とシード
(コンストラクタ)	エンジンを構築します。 (public member function)
seed	エンジンの現在の状態を設定します。 (public member function)
生成
operator()	エンジンの状態を進め、生成された値を返す (public member function)
discard	指定された量だけエンジンの状態を進めます。 (public メンバ関数)
特性
min [static]	出力範囲の最小値を返します。 (public static member function)
max [static]	出力範囲の最大値を返します。 (public static member function)

非メンバ関数

operator==operator!= (C++11)(C++11)(C++20で削除)	2つの擬似乱数エンジンの内部状態を比較します。 (関数)
operator<<operator>> (C++11)	疑似乱数エンジンのストリーム入出力を実行 (関数テンプレート)

不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 3809	C++11	default_seed は result_type で表現できない場合がある	型が変更された std::uint_least32_t