Simpler PRNG and faster magics search
[stockfish] / src / misc.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-2014 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
20 #ifndef MISC_H_INCLUDED
21 #define MISC_H_INCLUDED
22
23 #include <ostream>
24 #include <string>
25 #include <vector>
26
27 #include "types.h"
28
29 const std::string engine_info(bool to_uci = false);
30 void timed_wait(WaitCondition&, Lock&, int);
31 void prefetch(char* addr);
32 void start_logger(bool b);
33
34 void dbg_hit_on(bool b);
35 void dbg_hit_on_c(bool c, bool b);
36 void dbg_mean_of(int v);
37 void dbg_print();
38
39
40 namespace Time {
41   typedef int64_t point;
42   inline point now() { return system_time_to_msec(); }
43 }
44
45
46 template<class Entry, int Size>
47 struct HashTable {
48   HashTable() : table(Size, Entry()) {}
49   Entry* operator[](Key key) { return &table[(uint32_t)key & (Size - 1)]; }
50
51 private:
52   std::vector<Entry> table;
53 };
54
55
56 enum SyncCout { IO_LOCK, IO_UNLOCK };
57 std::ostream& operator<<(std::ostream&, SyncCout);
58
59 #define sync_cout std::cout << IO_LOCK
60 #define sync_endl std::endl << IO_UNLOCK
61
62
63 /// xorshift64star Pseudo-Random Number Generator
64 /// This class is based on original code written and dedicated
65 /// to the public domain by Sebastiano Vigna (2014).
66 /// It has the following characteristics:
67 ///  -  Outputs 64-bit numbers
68 ///  -  Passes Dieharder and SmallCrush test batteries
69 ///  -  Does not require warm-up, no zeroland to escape
70 ///  -  Internal state is a single 64-bit integer
71 ///  -  Period is 2^64 - 1
72 ///  -  Speed: 1.60 ns/call (Core i7 @3.40GHz)
73 /// For further analysis see
74 ///   <http://vigna.di.unimi.it/ftp/papers/xorshift.pdf>
75
76 class PRNG {
77
78   uint64_t x;
79
80   uint64_t rand64() {
81     x^=x>>12; x^=x<<25; x^=x>>27;
82     return x * 2685821657736338717LL;
83   }
84
85 public:
86   PRNG(uint64_t seed) : x(seed) { assert(seed); }
87
88   template<typename T> T rand() { return T(rand64()); }
89
90   /// Special generator used to fast init magic numbers.
91   /// Output values only have 1/8th of their bits set on average.
92   template<typename T> T sparse_rand() { return T(rand64() & rand64() & rand64()); }
93 };
94
95 #endif // #ifndef MISC_H_INCLUDED