Update copyright notes in rkiss.h
[stockfish] / src / rkiss.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
4   Copyright (C) 2008-2010 Marco Costalba, Joona Kiiski, Tord Romstad
5
6   Stockfish is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   Stockfish is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19   This file is based on original code by Heinz van Saanen and is
20   available under the GNU General Public License as published by
21   the Free Software Foundation, either version 3 of the License, or
22   (at your option) any later version.
23
24  ** George Marsaglia invented the RNG-Kiss-family in the early 90's.
25  ** This is a specific version that Heinz van Saanen derived and
26  ** tested from some public domain code by Bob Jenkins:
27  **
28  ** Quite platform independent
29  ** Passes ALL dieharder tests! Here *nix sys-rand() e.g. fails miserably:-)
30  ** ~12 times faster than my *nix sys-rand()
31  ** ~4 times faster than SSE2-version of Mersenne twister
32  ** Average cycle length: ~2^126
33  ** 64 bit seed
34  ** Return doubles with a full 53 bit mantissa
35  ** Thread safe
36 */
37
38 #if !defined(RKISS_H_INCLUDED)
39 #define RKISS_H_INCLUDED
40
41 #include "types.h"
42
43 class RKISS {
44
45   // Keep variables always together
46   struct S { uint64_t a, b, c, d; } s;
47
48   uint64_t rotate(uint64_t x, uint64_t k) const {
49     return (x << k) | (x >> (64 - k));
50   }
51
52   // Return 64 bit unsigned integer in between [0, 2^64 - 1]
53   uint64_t rand64() {
54
55     const uint64_t
56       e = s.a - rotate(s.b,  7);
57     s.a = s.b ^ rotate(s.c, 13);
58     s.b = s.c + rotate(s.d, 37);
59     s.c = s.d + e;
60     return s.d = e + s.a;
61   }
62
63   // Init seed and scramble a few rounds
64   void raninit() {
65
66     s.a = 0xf1ea5eed;
67     s.b = s.c = s.d = 0xd4e12c77;
68     for (int i = 0; i < 73; i++)
69         rand64();
70   }
71
72 public:
73   RKISS() { raninit(); }
74   template<typename T> T rand() { return T(rand64()); }
75 };
76
77 #endif // !defined(RKISS_H_INCLUDED)