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 }
185 template <class _Sseq, __enable_if_t<__is_seed_sequence_v<_Sseq, mersenne_twister_engine>, int> = 0>
186 _LIBCPP_HIDE_FROM_ABI void seed(_Sseq& __q) {
187 const unsigned __k = 1 + (__w - 1) / 32;
188 static_assert(__k <= 2);
189 uint32_t __ar[__n * __k];
190 __q.generate(__ar, __ar + __n * __k);
191 for (size_t __i = 0; __i < __n; ++__i) {
192 if _LIBCPP_CONSTEXPR (__k == 1) {
193 __x_[__i] = static_cast<result_type>(__ar[__i] & _Max);
194 } else {
195 __x_[__i] = static_cast<result_type>((__ar[2 * __i] + ((uint64_t)__ar[2 * __i + 1] << 32)) & _Max);
196 }
197 }
198 const result_type __mask = __r == _Dt ? result_type(~0) : (result_type(1) << __r) - result_type(1);
199 __i_ = 0;
200 if ((__x_[0] & ~__mask) == 0) {
201 for (size_t __i = 1; __i < __n; ++__i)
202 if (__x_[__i] != 0)
203 return;
204 __x_[0] = result_type(1) << (__w - 1);
205 }
206 }
207
208 // generating functions
209 [[__nodiscard__]] _LIBCPP_HIDE_FROM_ABI result_type operator()() {
210 const size_t __j = (__i_ + 1) % __n;
211 const result_type __mask = __r == _Dt ? result_type(~0) : (result_type(1) << __r) - result_type(1);
212 const result_type __yp = (__x_[__i_] & ~__mask) | (__x_[__j] & __mask);
213 const size_t __k = (__i_ + __m) % __n;
214 __x_[__i_] = __x_[__k] ^ __rshift<1>(__yp) ^ (__a * (__yp & 1));
215 result_type __z = __x_[__i_] ^ (__rshift<__u>(__x_[__i_]) & __d);
216 __i_ = __j;
217 __z ^= __lshift<__s>(__z) & __b;
218 __z ^= __lshift<__t>(__z) & __c;
219 return __z ^ __rshift<__l>(__z);
220 }
221
222 _LIBCPP_HIDE_FROM_ABI void discard(unsigned long long __z) {
223 for (; __z; --__z)
224 (void)operator()();
225 }
226
227 template <class _UInt,
228 size_t _Wp,
229 size_t _Np,
230 size_t _Mp,
231 size_t _Rp,
232 _UInt _Ap,
233 size_t _Up,
234 _UInt _Dp,
235 size_t _Sp,
236 _UInt _Bp,
237 size_t _Tp,
238 _UInt _Cp,
239 size_t _Lp,
240 _UInt _Fp>
241 friend bool operator==(
242 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x,
243 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __y);
244
245 template <class _CharT,
246 class _Traits,
247 class _UInt,
248 size_t _Wp,
249 size_t _Np,
250 size_t _Mp,
251 size_t _Rp,
252 _UInt _Ap,
253 size_t _Up,
254 _UInt _Dp,
255 size_t _Sp,
256 _UInt _Bp,
257 size_t _Tp,
258 _UInt _Cp,
259 size_t _Lp,
260 _UInt _Fp>
261 friend basic_ostream<_CharT, _Traits>& operator<<(
262 basic_ostream<_CharT, _Traits>& __os,
263 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x);
264
265 template <class _CharT,
266 class _Traits,
267 class _UInt,
268 size_t _Wp,
269 size_t _Np,
270 size_t _Mp,
271 size_t _Rp,
272 _UInt _Ap,
273 size_t _Up,
274 _UInt _Dp,
275 size_t _Sp,
276 _UInt _Bp,
277 size_t _Tp,
278 _UInt _Cp,
279 size_t _Lp,
280 _UInt _Fp>
281 friend basic_istream<_CharT, _Traits>&
282 operator>>(basic_istream<_CharT, _Traits>& __is,
283 mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x);
284
285private:
286 template <size_t __count>
287 _LIBCPP_HIDE_FROM_ABI static result_type __lshift(result_type __x) {
288 if _LIBCPP_CONSTEXPR (__count < __w) {
289 return (__x << __count) & _Max;
290 } else {
291 return result_type(0);
292 }
293 }
294
295 template <size_t __count>
296 _LIBCPP_HIDE_FROM_ABI static result_type __rshift(result_type __x) {
297 if _LIBCPP_CONSTEXPR (__count < _Dt) {
298 return __x >> __count;
299 } else {
300 return result_type(0);
301 }
302 }
303};
304
305template <class _UInt,
306 size_t _Wp,
307 size_t _Np,
308 size_t _Mp,
309 size_t _Rp,
310 _UInt _Ap,
311 size_t _Up,
312 _UInt _Dp,
313 size_t _Sp,
314 _UInt _Bp,
315 size_t _Tp,
316 _UInt _Cp,
317 size_t _Lp,
318 _UInt _Fp>
319_LIBCPP_HIDE_FROM_ABI bool
320operator==(const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x,
321 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __y) {
322 if (__x.__i_ == __y.__i_)
323 return std::equal(__x.__x_, __x.__x_ + _Np, __y.__x_);
324 if (__x.__i_ == 0 || __y.__i_ == 0) {
325 size_t __j = std::min(_Np - __x.__i_, _Np - __y.__i_);
326 if (!std::equal(__x.__x_ + __x.__i_, __x.__x_ + __x.__i_ + __j, __y.__x_ + __y.__i_))
327 return false;
328 if (__x.__i_ == 0)
329 return std::equal(__x.__x_ + __j, __x.__x_ + _Np, __y.__x_);
330 return std::equal(__x.__x_, __x.__x_ + (_Np - __j), __y.__x_ + __j);
331 }
332 if (__x.__i_ < __y.__i_) {
333 size_t __j = _Np - __y.__i_;
334 if (!std::equal(__x.__x_ + __x.__i_, __x.__x_ + (__x.__i_ + __j), __y.__x_ + __y.__i_))
335 return false;
336 if (!std::equal(__x.__x_ + (__x.__i_ + __j), __x.__x_ + _Np, __y.__x_))
337 return false;
338 return std::equal(__x.__x_, __x.__x_ + __x.__i_, __y.__x_ + (_Np - (__x.__i_ + __j)));
339 }
340 size_t __j = _Np - __x.__i_;
341 if (!std::equal(__y.__x_ + __y.__i_, __y.__x_ + (__y.__i_ + __j), __x.__x_ + __x.__i_))
342 return false;
343 if (!std::equal(__y.__x_ + (__y.__i_ + __j), __y.__x_ + _Np, __x.__x_))
344 return false;
345 return std::equal(__y.__x_, __y.__x_ + __y.__i_, __x.__x_ + (_Np - (__y.__i_ + __j)));
346}
347
348template <class _UInt,
349 size_t _Wp,
350 size_t _Np,
351 size_t _Mp,
352 size_t _Rp,
353 _UInt _Ap,
354 size_t _Up,
355 _UInt _Dp,
356 size_t _Sp,
357 _UInt _Bp,
358 size_t _Tp,
359 _UInt _Cp,
360 size_t _Lp,
361 _UInt _Fp>
362inline _LIBCPP_HIDE_FROM_ABI bool
363operator!=(const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x,
364 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __y) {
365 return !(__x == __y);
366}
367
368template <class _CharT,
369 class _Traits,
370 class _UInt,
371 size_t _Wp,
372 size_t _Np,
373 size_t _Mp,
374 size_t _Rp,
375 _UInt _Ap,
376 size_t _Up,
377 _UInt _Dp,
378 size_t _Sp,
379 _UInt _Bp,
380 size_t _Tp,
381 _UInt _Cp,
382 size_t _Lp,
383 _UInt _Fp>
384_LIBCPP_HIDE_FROM_ABI basic_ostream<_CharT, _Traits>&
385operator<<(basic_ostream<_CharT, _Traits>& __os,
386 const mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x) {
387 __save_flags<_CharT, _Traits> __lx(__os);
388 typedef basic_ostream<_CharT, _Traits> _Ostream;
389 __os.flags(_Ostream::dec | _Ostream::left);
390 _CharT __sp = __os.widen(' ');
391 __os.fill(__sp);
392 __os << __x.__x_[__x.__i_];
393 for (size_t __j = __x.__i_ + 1; __j < _Np; ++__j)
394 __os << __sp << __x.__x_[__j];
395 for (size_t __j = 0; __j < __x.__i_; ++__j)
396 __os << __sp << __x.__x_[__j];
397 return __os;
398}
399
400template <class _CharT,
401 class _Traits,
402 class _UInt,
403 size_t _Wp,
404 size_t _Np,
405 size_t _Mp,
406 size_t _Rp,
407 _UInt _Ap,
408 size_t _Up,
409 _UInt _Dp,
410 size_t _Sp,
411 _UInt _Bp,
412 size_t _Tp,
413 _UInt _Cp,
414 size_t _Lp,
415 _UInt _Fp>
416_LIBCPP_HIDE_FROM_ABI basic_istream<_CharT, _Traits>&
417operator>>(basic_istream<_CharT, _Traits>& __is,
418 mersenne_twister_engine<_UInt, _Wp, _Np, _Mp, _Rp, _Ap, _Up, _Dp, _Sp, _Bp, _Tp, _Cp, _Lp, _Fp>& __x) {
419 __save_flags<_CharT, _Traits> __lx(__is);
420 typedef basic_istream<_CharT, _Traits> _Istream;
421 __is.flags(_Istream::dec | _Istream::skipws);
422 _UInt __t[_Np];
423 for (size_t __i = 0; __i < _Np; ++__i)
424 __is >> __t[__i];
425 if (!__is.fail()) {
426 for (size_t __i = 0; __i < _Np; ++__i)
427 __x.__x_[__i] = __t[__i];
428 __x.__i_ = 0;
429 }
430 return __is;
431}
432
433typedef mersenne_twister_engine<
434 uint_fast32_t,
435 32,
436 624,
437 397,
438 31,
439 0x9908b0df,
440 11,
441 0xffffffff,
442 7,
443 0x9d2c5680,
444 15,
445 0xefc60000,
446 18,
447 1812433253>
448 mt19937;
449typedef mersenne_twister_engine<
450 uint_fast64_t,
451 64,
452 312,
453 156,
454 31,
455 0xb5026f5aa96619e9ULL,
456 29,
457 0x5555555555555555ULL,
458 17,
459 0x71d67fffeda60000ULL,
460 37,
461 0xfff7eee000000000ULL,
462 43,
463 6364136223846793005ULL>
464 mt19937_64;
465
466_LIBCPP_END_NAMESPACE_STD
467
468_LIBCPP_POP_MACROS
469
470#endif // _LIBCPP___RANDOM_MERSENNE_TWISTER_ENGINE_H
471