Showing content from https://en.cppreference.com/w/cpp/language/../numeric/random/philox_engine.html below:
std::philox_engine - cppreference.com
std::philox_engine
is a counter-based random number engine.
[edit] Template parameters UIntType - The result type generated by the generator. The effect is undefined if this is not one of unsigned short, unsigned int, unsigned long, or unsigned long long. w - the word size in bits n - the word count r - the round count consts - the sequence of multipliers and round constants used for generating random numbers
If any of the following values is not true, the program is ill-formed:
- sizeof...(consts) == n
- n == 2 || n == 4
- 0 < r
- 0 < w && w <= std::numeric_limits<UIntType>::digits
[edit] Generator properties
In the following description, let \(\scriptsize Q_i \)Qi denote the ith element of sequence Q, where the subscript starts from zero.
The size of the states of philox_engine
is \(\scriptsize O(n)\)O(n), each of them consists of four parts:
- A sequence X of n integer values, where each value is in
[
â0â,
2
w
)
.
-
- This sequence represents a large unsigned integer counter value \(\scriptsize Z=\sum_{j=0}^{n-1} X \cdot 2^{wj} \)Z=ân-1
j=0Xâ
2wj
of \(\scriptsize n \cdot w \)nâ
w bits.
- A sequence K of n / 2 keys of type
UIntType
.
- A buffer Y of n produced values of type
UIntType
.
- An index j in Y buffer.
The transition algorithm of philox_engine
(\(\scriptsize TA(X_i) \)TA(Xi)) is defined as follows:
- If j is not n - 1, increments j by 1.[1]
- If j is n - 1, performs the following operations:[2]
- Generates a new sequence of n random values (see below) and stores them in Y.
- Increments the counter Z by 1.
- Resets j to â0â.
The generation algorithm of philox_engine
is \(\scriptsize GA(X_i)=Y_j \)GA(Xi)=Yj.
- â In this case, the next generation algorithm call returns the next generated value in the buffer.
- â In this case, the buffer is refreshed, and the next generation algorithm call returns the first value in the new buffer.
[edit] Generating random values
Random values are generated from the following parameters:
- the number of rounds r
- the current counter sequence X
- the key sequence K
- the multiplier sequence M
- the round constant sequence C
The sequences M and C are formed from the values from template parameter pack consts, which represents the \(\scriptsize M_k \)Mk and \(\scriptsize C_k \)Ck constants as [
\(\scriptsize M_0 \)M0,
\(\scriptsize C_0 \)C0,
\(\scriptsize M_1 \)M1,
\(\scriptsize C_1 \)C1,... , ...,
\(\scriptsize M_{n/2-1} \)Mn/2-1,
\(\scriptsize C_{n/2-1} \)Cn/2-1]
.
Random numbers are generated by the following process:
- Initializes the output sequence S with the elements of X.
- Updates the elements of S for r rounds.
- Replaces the values in the buffer Y with the values in S.
[edit] Updating the output sequence
For each round of update, an intermediate sequence V is initialized with the elements of S in a specified order:
n \(\scriptsize V_{0} \)V0 \(\scriptsize V_{1} \)V1 \(\scriptsize V_{2} \)V2 \(\scriptsize V_{3} \)V3 2 \(\scriptsize S_0 \)S0 \(\scriptsize S_1 \)S1 N/A 4 \(\scriptsize S_2 \)S2 \(\scriptsize S_1 \)S1 \(\scriptsize S_0 \)S0 \(\scriptsize S_3 \)S3
Given the following operation notations:
- \(\scriptsize \mathsf{xor} \)xor, built-in bitwise XOR.
- \(\scriptsize \mathsf{mullo} \)mullo, it calcuates the low half of modular multiplication and is defined as \(\scriptsize \mathsf{mullo}(a,b,w)=(a \cdot b) \mod 2^w \)mullo(a,b,w)=(aâ
b) mod 2w
.
- \(\scriptsize \mathsf{mulhi} \)mulhi, it calcuates the high half of multiplication and is defined as \(\scriptsize \mathsf{mulhi}(a,b,w)=\left\lfloor (a \cdot b)/2^w \right\rfloor \)mulhi(a,b,w)=â(aâ
b)/2w
â.
Let q be the current round number (starting from zero), for each integer k in [
â0â,
n / 2)
, the elements of the output sequence S are updated as follows:
- \(\scriptsize X_{2 \cdot k}=\mathsf{mulhi}(V_{2 \cdot k},M_k,w)\ \mathsf{xor}\ ((K_k+q \cdot C_k) \mod 2^w)\ \mathsf{xor}\ V_{2 \cdot k+1} \)X2â
k=mulhi(V2â
k,Mk,w) xor ((Kk+qâ
Ck) mod 2w
) xor V2â
k+1
- \(\scriptsize X_{2 \cdot k+1}=\mathsf{mullo}(V_{2 \cdot k},M_k,w) \)X2â
k+1=mullo(V2â
k,Mk,w)
[edit] Predefined specializations
The following specializations define the random number engine with two commonly used parameter sets:
Type Definition philox4x32
(C++26) std::philox_engine<std::uint_fast32_t, 32, 4, 10,
0xCD9E8D57, 0x9E3779B9,
0xD2511F53, 0xBB67AE85>[edit] philox4x64
(C++26) std::philox_engine<std::uint_fast64_t, 64, 4, 10,
0xCA5A826395121157, 0x9E3779B97F4A7C15,
0xD2E7470EE14C6C93, 0xBB67AE8584CAA73B>[edit] [edit] Nested types Type Definition result_type
UIntType
[edit] Data members w
(public static member constant) n
(public static member constant) r
(public static member constant) constexpr std::array<result_type, word_count / 2> multipliers
[static]
the multiplier sequence M
(public static member constant) constexpr std::array<result_type, word_count / 2> round_consts
[static]
the round constant sequence C
(public static member constant) 20111115u
(public static member constant) [edit] Member functions Construction and Seeding constructs the engine
(public member function) [edit] sets the current state of the engine
(public member function) [edit] sets the current counter of the engine
(public member function) [edit] Generation advances the engine's state and returns the generated value
(public member function) [edit] advances the engine's state by a specified amount
(public member function) [edit] Characteristics gets the smallest possible value in the output range
(public static member function) [edit] gets the largest possible value in the output range
(public static member function) [edit] [edit] Non-member functions compares the internal states of two pseudo-random number engines
(function) [edit] performs stream input and output on pseudo-random number engine
(function template) [edit] [edit] Notes [edit] Example
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4