28bf045255ccd8b6aae115020ce285cc4fafb651
[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-2015 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 <cassert>
24 #include <ostream>
25 #include <string>
26 #include <vector>
27
28 #include "types.h"
29
30 const std::string engine_info(bool to_uci = false);
31 void prefetch(void* addr);
32 void start_logger(bool b);
33
34 void dbg_hit_on(bool b);
35 void dbg_hit_on(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   point now();
43 }
44
45
46 template<class Entry, int Size>
47 struct HashTable {
48   Entry* operator[](Key key) { return &table[(uint32_t)key & (Size - 1)]; }
49
50 private:
51   std::vector<Entry> table = std::vector<Entry>(Size);
52 };
53
54
55 enum SyncCout { IO_LOCK, IO_UNLOCK };
56 std::ostream& operator<<(std::ostream&, SyncCout);
57
58 #define sync_cout std::cout << IO_LOCK
59 #define sync_endl std::endl << IO_UNLOCK
60
61
62 /// xorshift64star Pseudo-Random Number Generator
63 /// This class is based on original code written and dedicated
64 /// to the public domain by Sebastiano Vigna (2014).
65 /// It has the following characteristics:
66 ///
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 ///
74 /// For further analysis see
75 ///   <http://vigna.di.unimi.it/ftp/papers/xorshift.pdf>
76
77 class PRNG {
78
79   uint64_t s;
80
81   uint64_t rand64() {
82
83     s ^= s >> 12, s ^= s << 25, s ^= s >> 27;
84     return s * 2685821657736338717LL;
85   }
86
87 public:
88   PRNG(uint64_t seed) : s(seed) { assert(seed); }
89
90   template<typename T> T rand() { return T(rand64()); }
91
92   /// Special generator used to fast init magic numbers.
93   /// Output values only have 1/8th of their bits set on average.
94   template<typename T> T sparse_rand()
95   { return T(rand64() & rand64() & rand64()); }
96 };
97
98 #endif // #ifndef MISC_H_INCLUDED