1//===----------------------------------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef _LIBCPP___RANDOM_MERSENNE_TWISTER_ENGINE_H
10#define _LIBCPP___RANDOM_MERSENNE_TWISTER_ENGINE_H
11
12#include <__algorithm/equal.h>
13#include <__algorithm/min.h>
14#include <__config>
15#include <__cstddef/size_t.h>
16#include <__random/is_seed_sequence.h>
17#include <__type_traits/enable_if.h>
18#include <cstdint>
19#include <iosfwd>
20#include <limits>
21
22#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
23# pragma GCC system_header
24#endif
25
26_LIBCPP_PUSH_MACROS
27#include <__undef_macros>
28
29_LIBCPP_BEGIN_NAMESPACE_STD
30
31template <class _UIntType,
32 size_t __w,
33 size_t __n,
34 size_t __m,
35 size_t __r,
36 _UIntType __a,
37 size_t __u,
38 _UIntType __d,
39 size_t __s,
40 _UIntType __b,
41 size_t __t,
42 _UIntType __c,
43 size_t __l,
44 _UIntType __f>
45class mersenne_twister_engine;
46
47template <class _UInt,
48 size_t _Wp,
49 size_t _Np,
50 size_t _Mp,
51 size_t _Rp,
52 _UInt _Ap,
53 size_t _Up,
54 _UInt _Dp,
55 size_t _Sp,
56 _UInt _Bp,
57 size_t _Tp,
58 _UInt _Cp,
59 size_t _Lp,
60 _UInt _Fp>
61_LIBCPP_HIDE_FROM_ABI bool
62operator==(const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x,
63 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __y);
64
65template <class _CharT,
66 class _Traits,
67 class _UInt,
68 size_t _Wp,
69 size_t _Np,
70 size_t _Mp,
71 size_t _Rp,
72 _UInt _Ap,
73 size_t _Up,
74 _UInt _Dp,
75 size_t _Sp,
76 _UInt _Bp,
77 size_t _Tp,
78 _UInt _Cp,
79 size_t _Lp,
80 _UInt _Fp>
81_LIBCPP_HIDE_FROM_ABI basic_ostream<_CharT, _Traits>&
82operator<<(basic_ostream<_CharT, _Traits>& __os,
83 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x);
84
85template <class _CharT,
86 class _Traits,
87 class _UInt,
88 size_t _Wp,
89 size_t _Np,
90 size_t _Mp,
91 size_t _Rp,
92 _UInt _Ap,
93 size_t _Up,
94 _UInt _Dp,
95 size_t _Sp,
96 _UInt _Bp,
97 size_t _Tp,
98 _UInt _Cp,
99 size_t _Lp,
100 _UInt _Fp>
101_LIBCPP_HIDE_FROM_ABI basic_istream<_CharT, _Traits>&
102operator>>(basic_istream<_CharT, _Traits>& __is,
103 mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x);
104
105template <class _UIntType,
106 size_t __w,
107 size_t __n,
108 size_t __m,
109 size_t __r,
110 _UIntType __a,
111 size_t __u,
112 _UIntType __d,
113 size_t __s,
114 _UIntType __b,
115 size_t __t,
116 _UIntType __c,
117 size_t __l,
118 _UIntType __f>
119class mersenne_twister_engine {
120public:
121 // types
122 typedef _UIntType result_type;
123
124private:
125 result_type __x_[__n];
126 size_t __i_;
127
128 static_assert(0 < __m, "mersenne_twister_engine invalid parameters");
129 static_assert(__m <= __n, "mersenne_twister_engine invalid parameters");
130 static _LIBCPP_CONSTEXPR const result_type _Dt = numeric_limits<result_type>::digits;
131 static_assert(__w <= _Dt, "mersenne_twister_engine invalid parameters");
132 static_assert(2 <= __w, "mersenne_twister_engine invalid parameters");
133 static_assert(__r <= __w, "mersenne_twister_engine invalid parameters");
134 static_assert(__u <= __w, "mersenne_twister_engine invalid parameters");
135 static_assert(__s <= __w, "mersenne_twister_engine invalid parameters");
136 static_assert(__t <= __w, "mersenne_twister_engine invalid parameters");
137 static_assert(__l <= __w, "mersenne_twister_engine invalid parameters");
138
139public:
140 static _LIBCPP_CONSTEXPR const result_type _Min = 0;
141 static _LIBCPP_CONSTEXPR const result_type _Max =
142 __w == _Dt ? result_type(~0) : (result_type(1) << __w) - result_type(1);
143 static_assert(_Min < _Max, "mersenne_twister_engine invalid parameters");
144 static_assert(__a <= _Max, "mersenne_twister_engine invalid parameters");
145 static_assert(__b <= _Max, "mersenne_twister_engine invalid parameters");
146 static_assert(__c <= _Max, "mersenne_twister_engine invalid parameters");
147 static_assert(__d <= _Max, "mersenne_twister_engine invalid parameters");
148 static_assert(__f <= _Max, "mersenne_twister_engine invalid parameters");
149
150 // engine characteristics
151 static inline _LIBCPP_CONSTEXPR const size_t word_size = __w;
152 static inline _LIBCPP_CONSTEXPR const size_t state_size = __n;
153 static inline _LIBCPP_CONSTEXPR const size_t shift_size = __m;
154 static inline _LIBCPP_CONSTEXPR const size_t mask_bits = __r;
155 static inline _LIBCPP_CONSTEXPR const result_type xor_mask = __a;
156 static inline _LIBCPP_CONSTEXPR const size_t tempering_u = __u;
157 static inline _LIBCPP_CONSTEXPR const result_type tempering_d = __d;
158 static inline _LIBCPP_CONSTEXPR const size_t tempering_s = __s;
159 static inline _LIBCPP_CONSTEXPR const result_type tempering_b = __b;
160 static inline _LIBCPP_CONSTEXPR const size_t tempering_t = __t;
161 static inline _LIBCPP_CONSTEXPR const result_type tempering_c = __c;
162 static inline _LIBCPP_CONSTEXPR const size_t tempering_l = __l;
163 static inline _LIBCPP_CONSTEXPR const result_type initialization_multiplier = __f;
164 [[__nodiscard__]] _LIBCPP_HIDE_FROM_ABI static _LIBCPP_CONSTEXPR result_type min() { return _Min; }
165 [[__nodiscard__]] _LIBCPP_HIDE_FROM_ABI static _LIBCPP_CONSTEXPR result_type max() { return _Max; }
166 static inline _LIBCPP_CONSTEXPR const result_type default_seed = 5489u;
167
168 // constructors and seeding functions
169#ifndef _LIBCPP_CXX03_LANG
170 _LIBCPP_HIDE_FROM_ABI mersenne_twister_engine() : mersenne_twister_engine(default_seed) {}
171 _LIBCPP_HIDE_FROM_ABI explicit mersenne_twister_engine(result_type __sd) { seed(__sd); }
172#else
173 _LIBCPP_HIDE_FROM_ABI explicit mersenne_twister_engine(result_type __sd = default_seed) { seed(__sd); }
174#endif
175 template <class _Sseq, __enable_if_t<__is_seed_sequence_v<_Sseq, mersenne_twister_engine>, int> = 0>
176 _LIBCPP_HIDE_FROM_ABI explicit mersenne_twister_engine(_Sseq& __q) {
177 seed(__q);
178 }
179 _LIBCPP_HIDE_FROM_ABI void seed(result_type __sd = default_seed) _LIBCPP_DISABLE_UBSAN_UNSIGNED_INTEGER_CHECK {
180 __x_[0] = __sd & _Max;
181 for (size_t __i = 1; __i < __n; ++__i)
182 __x_[__i] = (__f * (__x_[__i - 1] ^ __rshift<__w - 2>(__x_[__i - 1])) + __i) & _Max;
183 __i_ = 0;
184#ifdef _LIBCPP_ABI_VECTORIZED_MERSENNE_TWISTER_ENGINE
185 __update_all_states();
186#endif
187 }
188 template <class _Sseq, __enable_if_t<__is_seed_sequence_v<_Sseq, mersenne_twister_engine>, int> = 0>
189 _LIBCPP_HIDE_FROM_ABI void seed(_Sseq& __q) {
190 const unsigned __k = 1 + (__w - 1) / 32;
191 static_assert(__k <= 2);
192 uint32_t __ar[__n * __k];
193 __q.generate(__ar, __ar + __n * __k);
194 for (size_t __i = 0; __i < __n; ++__i) {
195 if _LIBCPP_CONSTEXPR (__k == 1) {
196 __x_[__i] = static_cast<result_type>(__ar[__i] & _Max);
197 } else {
198 __x_[__i] = static_cast<result_type>((__ar[2 * __i] + ((uint64_t)__ar[2 * __i + 1] << 32)) & _Max);
199 }
200 }
201 const result_type __mask = __r == _Dt ? result_type(~0) : (result_type(1) << __r) - result_type(1);
202 __i_ = 0;
203 if ((__x_[0] & ~__mask) == 0) {
204 size_t __i = 1;
205 for (; __i < __n; ++__i)
206 if (__x_[__i] != 0)
207 break;
208 if (__i == __n)
209 __x_[0] = result_type(1) << (__w - 1);
210 }
211#ifdef _LIBCPP_ABI_VECTORIZED_MERSENNE_TWISTER_ENGINE
212 __update_all_states();
213#endif
214 }
215
216 void __update_state(size_t __i, size_t __k) {
217 const size_t __j = (__i + 1) % __n;
218 const result_type __mask = __r == _Dt ? result_type(~0) : (result_type(1) << __r) - result_type(1);
219 const result_type __yp = (__x_[__i] & ~__mask) | (__x_[__j] & __mask);
220 __x_[__i] = __x_[__k] ^ __rshift<1>(__yp) ^ (__a * (__yp & 1));
221 }
222
223 void __update_state(size_t __i) { __update_state(__i, (__i + __m) % __n); }
224
225 void __update_all_states() {
226 size_t __i = 0;
227 // This is split into two loops to help the compiler vectorize the code
228 for (; __i != (__n - __m); ++__i)
229 __update_state(__i);
230 for (size_t __j = 0; __i != __n; ++__i, ++__j)
231 __update_state(__i, __j);
232 }
233
234 // generating functions
235 [[__nodiscard__]] _LIBCPP_HIDE_FROM_ABI result_type operator()() {
236#ifdef _LIBCPP_ABI_VECTORIZED_MERSENNE_TWISTER_ENGINE
237 result_type __val = __x_[__i_];
238 if (++__i_ == __n) [[__unlikely__]] {
239 __update_all_states();
240 __i_ = 0;
241 }
242#else
243 __update_state(__i_);
244 result_type __val = __x_[__i_];
245 __i_ = (__i_ + 1) % __n;
246#endif
247 result_type __z = __val ^ (__rshift<__u>(__val) & __d);
248 __z ^= __lshift<__s>(__z) & __b;
249 __z ^= __lshift<__t>(__z) & __c;
250 return __z ^ __rshift<__l>(__z);
251 }
252
253 _LIBCPP_HIDE_FROM_ABI void discard(unsigned long long __z) {
254 for (; __z; --__z)
255 (void)operator()();
256 }
257
258 template <class _UInt,
259 size_t _Wp,
260 size_t _Np,
261 size_t _Mp,
262 size_t _Rp,
263 _UInt _Ap,
264 size_t _Up,
265 _UInt _Dp,
266 size_t _Sp,
267 _UInt _Bp,
268 size_t _Tp,
269 _UInt _Cp,
270 size_t _Lp,
271 _UInt _Fp>
272 friend bool operator==(
273 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x,
274 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __y);
275
276 template <class _CharT,
277 class _Traits,
278 class _UInt,
279 size_t _Wp,
280 size_t _Np,
281 size_t _Mp,
282 size_t _Rp,
283 _UInt _Ap,
284 size_t _Up,
285 _UInt _Dp,
286 size_t _Sp,
287 _UInt _Bp,
288 size_t _Tp,
289 _UInt _Cp,
290 size_t _Lp,
291 _UInt _Fp>
292 friend basic_ostream<_CharT, _Traits>& operator<<(
293 basic_ostream<_CharT, _Traits>& __os,
294 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x);
295
296 template <class _CharT,
297 class _Traits,
298 class _UInt,
299 size_t _Wp,
300 size_t _Np,
301 size_t _Mp,
302 size_t _Rp,
303 _UInt _Ap,
304 size_t _Up,
305 _UInt _Dp,
306 size_t _Sp,
307 _UInt _Bp,
308 size_t _Tp,
309 _UInt _Cp,
310 size_t _Lp,
311 _UInt _Fp>
312 friend basic_istream<_CharT, _Traits>&
313 operator>>(basic_istream<_CharT, _Traits>& __is,
314 mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x);
315
316private:
317 template <size_t __count>
318 _LIBCPP_HIDE_FROM_ABI static result_type __lshift(result_type __x) {
319 if _LIBCPP_CONSTEXPR (__count < __w) {
320 return (__x << __count) & _Max;
321 } else {
322 return result_type(0);
323 }
324 }
325
326 template <size_t __count>
327 _LIBCPP_HIDE_FROM_ABI static result_type __rshift(result_type __x) {
328 if _LIBCPP_CONSTEXPR (__count < _Dt) {
329 return __x >> __count;
330 } else {
331 return result_type(0);
332 }
333 }
334};
335
336template <class _UInt,
337 size_t _Wp,
338 size_t _Np,
339 size_t _Mp,
340 size_t _Rp,
341 _UInt _Ap,
342 size_t _Up,
343 _UInt _Dp,
344 size_t _Sp,
345 _UInt _Bp,
346 size_t _Tp,
347 _UInt _Cp,
348 size_t _Lp,
349 _UInt _Fp>
350_LIBCPP_HIDE_FROM_ABI bool
351operator==(const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x,
352 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __y) {
353 if (__x.__i_ == __y.__i_)
354 return std::equal(__x.__x_, __x.__x_ + _Np, __y.__x_);
355 if (__x.__i_ == 0 || __y.__i_ == 0) {
356 size_t __j = std::min(_Np - __x.__i_, _Np - __y.__i_);
357 if (!std::equal(__x.__x_ + __x.__i_, __x.__x_ + __x.__i_ + __j, __y.__x_ + __y.__i_))
358 return false;
359 if (__x.__i_ == 0)
360 return std::equal(__x.__x_ + __j, __x.__x_ + _Np, __y.__x_);
361 return std::equal(__x.__x_, __x.__x_ + (_Np - __j), __y.__x_ + __j);
362 }
363 if (__x.__i_ < __y.__i_) {
364 size_t __j = _Np - __y.__i_;
365 if (!std::equal(__x.__x_ + __x.__i_, __x.__x_ + (__x.__i_ + __j), __y.__x_ + __y.__i_))
366 return false;
367 if (!std::equal(__x.__x_ + (__x.__i_ + __j), __x.__x_ + _Np, __y.__x_))
368 return false;
369 return std::equal(__x.__x_, __x.__x_ + __x.__i_, __y.__x_ + (_Np - (__x.__i_ + __j)));
370 }
371 size_t __j = _Np - __x.__i_;
372 if (!std::equal(__y.__x_ + __y.__i_, __y.__x_ + (__y.__i_ + __j), __x.__x_ + __x.__i_))
373 return false;
374 if (!std::equal(__y.__x_ + (__y.__i_ + __j), __y.__x_ + _Np, __x.__x_))
375 return false;
376 return std::equal(__y.__x_, __y.__x_ + __y.__i_, __x.__x_ + (_Np - (__y.__i_ + __j)));
377}
378
379template <class _UInt,
380 size_t _Wp,
381 size_t _Np,
382 size_t _Mp,
383 size_t _Rp,
384 _UInt _Ap,
385 size_t _Up,
386 _UInt _Dp,
387 size_t _Sp,
388 _UInt _Bp,
389 size_t _Tp,
390 _UInt _Cp,
391 size_t _Lp,
392 _UInt _Fp>
393inline _LIBCPP_HIDE_FROM_ABI bool
394operator!=(const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x,
395 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __y) {
396 return !(__x == __y);
397}
398
399template <class _CharT,
400 class _Traits,
401 class _UInt,
402 size_t _Wp,
403 size_t _Np,
404 size_t _Mp,
405 size_t _Rp,
406 _UInt _Ap,
407 size_t _Up,
408 _UInt _Dp,
409 size_t _Sp,
410 _UInt _Bp,
411 size_t _Tp,
412 _UInt _Cp,
413 size_t _Lp,
414 _UInt _Fp>
415_LIBCPP_HIDE_FROM_ABI basic_ostream<_CharT, _Traits>&
416operator<<(basic_ostream<_CharT, _Traits>& __os,
417 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x) {
418 __save_flags<_CharT, _Traits> __lx(__os);
419 typedef basic_ostream<_CharT, _Traits> _Ostream;
420 __os.flags(_Ostream::dec | _Ostream::left);
421 _CharT __sp = __os.widen(' ');
422 __os.fill(__sp);
423 __os << __x.__x_[__x.__i_];
424 for (size_t __j = __x.__i_ + 1; __j < _Np; ++__j)
425 __os << __sp << __x.__x_[__j];
426 for (size_t __j = 0; __j < __x.__i_; ++__j)
427 __os << __sp << __x.__x_[__j];
428 return __os;
429}
430
431template <class _CharT,
432 class _Traits,
433 class _UInt,
434 size_t _Wp,
435 size_t _Np,
436 size_t _Mp,
437 size_t _Rp,
438 _UInt _Ap,
439 size_t _Up,
440 _UInt _Dp,
441 size_t _Sp,
442 _UInt _Bp,
443 size_t _Tp,
444 _UInt _Cp,
445 size_t _Lp,
446 _UInt _Fp>
447_LIBCPP_HIDE_FROM_ABI basic_istream<_CharT, _Traits>&
448operator>>(basic_istream<_CharT, _Traits>& __is,
449 mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x) {
450 __save_flags<_CharT, _Traits> __lx(__is);
451 typedef basic_istream<_CharT, _Traits> _Istream;
452 __is.flags(_Istream::dec | _Istream::skipws);
453 _UInt __t[_Np];
454 for (size_t __i = 0; __i < _Np; ++__i)
455 __is >> __t[__i];
456 if (!__is.fail()) {
457 for (size_t __i = 0; __i < _Np; ++__i)
458 __x.__x_[__i] = __t[__i];
459 __x.__i_ = 0;
460 }
461 return __is;
462}
463
464typedef mersenne_twister_engine<
465 uint_fast32_t,
466 32,
467 624,
468 397,
469 31,
470 0x9908b0df,
471 11,
472 0xffffffff,
473 7,
474 0x9d2c5680,
475 15,
476 0xefc60000,
477 18,
478 1812433253>
479 mt19937;
480typedef mersenne_twister_engine<
481 uint_fast64_t,
482 64,
483 312,
484 156,
485 31,
486 0xb5026f5aa96619e9ULL,
487 29,
488 0x5555555555555555ULL,
489 17,
490 0x71d67fffeda60000ULL,
491 37,
492 0xfff7eee000000000ULL,
493 43,
494 6364136223846793005ULL>
495 mt19937_64;
496
497_LIBCPP_END_NAMESPACE_STD
498
499_LIBCPP_POP_MACROS
500
501#endif // _LIBCPP___RANDOM_MERSENNE_TWISTER_ENGINE_H
502