std::philox_engine

ヘッダー `<random>` で定義
template< class UIntType, std::size_t w, std::size_t n, std::size_t r, UIntType... consts > class philox_engine;		(C++26以降)

std::philox_engine はカウンタベースの乱数生成器です。

UIntType	-	ジェネレータによって生成される結果の型。これが`unsigned short`、`unsigned int`、`unsigned long`、または`unsigned long long`のいずれでもない場合、動作は未定義です。
w	-	ワードサイズ（ビット単位）
n	-	ワード数
r	-	ラウンド数
consts	-	乱数生成に使用される乗数およびラウンド定数のシーケンス

以下の値のいずれかが true でない場合、プログラムは不正形式となります。

sizeof...(consts) == n
n == 2 || n == 4
0 < r
0 < w && w <= std::numeric_limits<UIntType>::digits

[編集] ジェネレータのプロパティ

以下の説明では、添え字がゼロから始まるシーケンス Q の i 番目の要素を $\scriptsize Q_i $ $Q i$ とします。

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

n 個の整数値のシーケンス X。各値は [0, $2 w$ ) の範囲にあります。

これは、$\scriptsize n \cdot w $ $n\cdotw$ ビットの大きな符号なし整数カウンタ値 $Z=\sum n-1 j=0 X\cdot2 wj$ を表します。

型 UIntType の n / 2 個のキーのシーケンス K。
型 UIntType の n 個の生成された値のバッファ Y。
Y バッファ内のインデックス j。

philox_engine の遷移アルゴリズム（$\scriptsize TA(X_i) $ $TA(X i)$ ）は次のように定義されます。

j が n - 1 でない場合、j を 1 増分します。^[1]
j が n - 1 の場合、以下の操作を実行します。^[2]

(下記参照) n 個の新しい乱数列を生成し、Y に格納します。
カウンタ Z を 1 増分します。
j を 0 にリセットします。

philox_engine の生成アルゴリズムは $\scriptsize GA(X_i)=Y_j $ $GA(X i)=Y j$ です。

↑ この場合、次の生成アルゴリズム呼び出しは、バッファ内の次の生成された値を返します。
↑ この場合、バッファはリフレッシュされ、次の生成アルゴリズム呼び出しは新しいバッファの最初の値を返します。

[編集] 乱数の生成

乱数は以下のパラメータから生成されます。

ラウンド数 r
現在のカウンタシーケンス X
キーシーケンス K
乗数シーケンス M
ラウンド定数シーケンス C

シーケンス M と C は、テンプレートパラメータパック consts の値から形成されます。これは、$\scriptsize M_k $ $M k$ および $\scriptsize C_k $ $C k$ 定数を [$\scriptsize M_0 $ $M 0$ , $\scriptsize C_0 $ $C 0$ , $\scriptsize M_1 $ $M 1$ , $\scriptsize C_1 $ $C 1$ ,... , ..., $\scriptsize M_{n/2-1} $ $M n/2-1$ , $\scriptsize C_{n/2-1} $ $C n/2-1$ ]として表します。

乱数は以下のプロセスで生成されます。

出力シーケンス S を X の要素で初期化します。
r ラウンドにわたって S の要素を更新します。
バッファ Y の値を S の値で置き換えます。

[編集] 出力シーケンスの更新

更新の各ラウンドで、中間シーケンス V は指定された順序で S の要素で初期化されます。

n	$\scriptsize V_{0} $ $V 0$	$\scriptsize V_{1} $ $V 1$	$\scriptsize V_{2} $ $V 2$	$\scriptsize V_{3} $ $V 3$
2	$\scriptsize S_0 $ $S 0$	$\scriptsize S_1 $ $S 1$	N/A
4	$\scriptsize S_2 $ $S 2$	$\scriptsize S_1 $ $S 1$	$\scriptsize S_0 $ $S 0$	$\scriptsize S_3 $ $S 3$

以下の演算表記を使用します。

$\scriptsize \mathsf{xor} $ $xor$ : ビルトインのビットごとのXOR。
$\scriptsize \mathsf{mullo} $ $mullo$ : モジュラ乗算の下位半分を計算し、 $mullo(a,b,w)=(a\cdotb) mod 2 w$ と定義されます。
$\scriptsize \mathsf{mulhi} $ $mulhi$ : 乗算の上位半分を計算し、 $mulhi(a,b,w)=⌊(a\cdotb)/2 w ⌋$ と定義されます。

現在のラウンド番号（ゼロから始まる）を q とし、k を [0, n / 2) の整数とします。出力シーケンス S の要素は次のように更新されます。

$X 2\cdotk =mulhi(V 2\cdotk,M k,w) xor ((K k +q\cdotC k) mod 2 w) xor V 2\cdotk+1$
$X 2\cdotk+1 =mullo(V 2\cdotk,M k,w)$

[編集] 事前定義された特殊化

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

ヘッダー `<random>` で定義
型	定義
`philox4x32` (C++26)	std::philox_engine<std::uint_fast32_t, 32, 4, 10, 0xCD9E8D57, 0x9E3779B9, 0xD2511F53, 0xBB67AE85>[編集]
`philox4x64` (C++26)	std::philox_engine<std::uint_fast64_t, 64, 4, 10, 0xCA5A826395121157, 0x9E3779B97F4A7C15, 0xD2E7470EE14C6C93, 0xBB67AE8584CAA73B>[編集]

[編集] ネストされた型

型	定義
`result_type`	`UIntType`

[編集] データメンバー

constexpr std::size_t word_size [static]	w (公開静的メンバ定数)
constexpr std::size_t word_count [static]	n (公開静的メンバ定数)
constexpr std::size_t round_count [static]	r (公開静的メンバ定数)
constexpr std::array<result_type, word_count / 2> multipliers [static]	乗数シーケンス M (公開静的メンバ定数)
constexpr std::array<result_type, word_count / 2> round_consts [static]	ラウンド定数シーケンス C (公開静的メンバ定数)
constexpr std::uint_least32_t default_seed [static]	20111115u (公開静的メンバ定数)

[編集] メンバ関数

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

[編集] 非メンバ関数

operator== (C++26)	2つの擬似乱数エンジンの内部状態を比較します。 (関数) [編集]

operator<<operator>> (C++26)	疑似乱数エンジンのストリーム入出力を実行 (関数テンプレート) [編集]

[編集] 注釈

機能テストマクロ	値	規格	機能
`__cpp_lib_philox_engine`	`202406L`	(C++26)	`std::philox_engine`

[編集] 例

[1] この場合、次の生成アルゴリズム呼び出しは、バッファ内の次の生成された値を返します。

[2] この場合、バッファはリフレッシュされ、次の生成アルゴリズム呼び出しは新しいバッファの最初の値を返します。

[1]

[2]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

メンバ関数
philox_engine::philox_engine
philox_engine::seed
philox_engine::set_counter
生成
philox_engine::operator()
philox_engine::discard
特性
philox_engine::min
philox_engine::max
非メンバ関数
operator== (C++26)
operator<<operator>> (C++26)(C++26)

n	\(\scriptsize V_{0} \) $V 0$	\(\scriptsize V_{1} \) $V 1$	\(\scriptsize V_{2} \) $V 2$	\(\scriptsize V_{3} \) $V 3$
2	\(\scriptsize S_0 \) $S 0$	\(\scriptsize S_1 \) $S 1$	N/A
4	\(\scriptsize S_2 \) $S 2$	\(\scriptsize S_1 \) $S 1$	\(\scriptsize S_0 \) $S 0$	\(\scriptsize S_3 \) $S 3$

cppreference.com

名前空間

変種

表示

操作