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 — это счетчиковый генератор случайных чисел.

Содержание 1 Параметры шаблона 2 Свойства генератора 2.1 Генерация случайных значений 2.2 Обновление выходной последовательности 3 Предопределенные специализации 4 Вложенные типы 5 Члены данных 6 Функции-члены 6.1 Конструкция и инициализация 6.2 Генерация 6.3 Характеристики 7 Функции не-члены 8 Примечания 9 Пример

Параметры шаблона

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

Свойства генератора

В следующем описании пусть \(\scriptsize Q_i \) Q i обозначает i -й элемент последовательности Q , где индекс начинается с нуля.

Размер состояний philox_engine составляет \(\scriptsize O(n)\) O(n) , каждое из них состоит из четырёх частей:

• Последовательность X из n целочисленных значений, где каждое значение находится в диапазоне [ ​ 0 ​ , 2 w
) .

• Эта последовательность представляет большое целое беззнаковое значение счетчика \(\scriptsize Z=\sum_{j=0}^{n-1} X \cdot 2^{wj} \) Z=∑ n-1
  j=0 X⋅2 wj
  размером \(\scriptsize n \cdot w \) n⋅w бит.

• Последовательность K из n / 2 ключей типа UIntType .
• Буфер Y из n сгенерированных значений типа UIntType .
• Индекс j в буфере Y .

Алгоритм перехода для philox_engine ( \(\scriptsize TA(X_i) \) TA(X i ) ) определяется следующим образом:

• Если j не равно n - 1 , увеличивает j на 1 . ^[1]
• Если j равно n - 1 , выполняет следующие операции: ^[2]

1. Генерирует новую последовательность из n случайных значений (см. ниже) и сохраняет их в Y .
2. Увеличивает счётчик Z на 1 .
3. Сбрасывает j в ​ 0 ​ .

Алгоритм генерации для philox_engine имеет вид \(\scriptsize GA(X_i)=Y_j \) GA(X i )=Y j .

1. ↑ В этом случае вызов алгоритма следующего поколения возвращает следующее сгенерированное значение в буфере.
2. ↑ В этом случае буфер обновляется, и вызов алгоритма следующего поколения возвращает первое значение в новом буфере.

Генерация случайных значений

Случайные значения генерируются из следующих параметров:

• количество раундов 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 ] .

Случайные числа генерируются следующим процессом:

1. Инициализирует выходную последовательность S элементами из X .
2. Обновляет элементы S в течение r раундов.
3. Заменяет значения в буфере 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	Н/Д
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 , вычисляет младшую половину модульного умножения и определяется как \(\scriptsize \mathsf{mullo}(a,b,w)=(a \cdot b) \mod 2^w \) mullo(a,b,w)=(a⋅b) mod 2 w
  .
• \(\scriptsize \mathsf{mulhi} \) mulhi , вычисляет старшую половину умножения и определяется как \(\scriptsize \mathsf{mulhi}(a,b,w)=\left\lfloor (a \cdot b)/2^w \right\rfloor \) mulhi(a,b,w)=⌊(a⋅b)/2 w
  ⌋ .

Пусть q будет текущим номером раунда (начиная с нуля), для каждого целого числа k в [ ​ 0 ​ , n / 2 ) , элементы выходной последовательности S обновляются следующим образом:

• \(\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} \) X 2⋅k =mulhi(V 2⋅k ,M k ,w) xor ((K k +q⋅C k ) mod 2 w
  ) xor V 2⋅k+1
• \(\scriptsize X_{2 \cdot k+1}=\mathsf{mullo}(V_{2 \cdot k},M_k,w) \) X 2⋅k+1 =mullo(V 2⋅k ,M k ,w)

Предопределенные специализации

Следующие специализации определяют генератор случайных чисел с двумя часто используемыми наборами параметров:

Определено в заголовке <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 (публичная статическая константа-член)

Функции-члены

Конструкция и инициализация
(constructor)	конструирует движок (public member function)
seed	устанавливает текущее состояние движка (public member function)
set_counter	устанавливает текущий счетчик движка (public member function)
Генерация
operator()	продвигает состояние движка и возвращает сгенерированное значение (public member function)
discard	продвигает состояние движка на указанное количество (public member function)
Характеристики
min [static]	получает наименьшее возможное значение в выходном диапазоне (public static member function)
max [static]	получает наибольшее возможное значение в выходном диапазоне (public static member function)

Функции, не являющиеся членами класса

operator== (C++26)	сравнивает внутренние состояния двух генераторов псевдослучайных чисел (функция)
operator<< operator>> (C++26)	выполняет потоковый ввод и вывод для генератора псевдослучайных чисел (шаблон функции)

Примечания

Макрос тестирования возможностей	Значение	Стандарт	Возможность
__cpp_lib_philox_engine	202406L	(C++26)	std::philox_engine

Пример

Этот раздел не завершён Причина: отсутствует пример