Update comments in LMR step
[stockfish] / src / types.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   Copyright (C) 2015-2016 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef TYPES_H_INCLUDED
22 #define TYPES_H_INCLUDED
23
24 /// When compiling with provided Makefile (e.g. for Linux and OSX), configuration
25 /// is done automatically. To get started type 'make help'.
26 ///
27 /// When Makefile is not used (e.g. with Microsoft Visual Studio) some switches
28 /// need to be set manually:
29 ///
30 /// -DNDEBUG      | Disable debugging mode. Always use this for release.
31 ///
32 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. You may need this to
33 ///               | run on some very old machines.
34 ///
35 /// -DUSE_POPCNT  | Add runtime support for use of popcnt asm-instruction. Works
36 ///               | only in 64-bit mode and requires hardware with popcnt support.
37 ///
38 /// -DUSE_PEXT    | Add runtime support for use of pext asm-instruction. Works
39 ///               | only in 64-bit mode and requires hardware with pext support.
40
41 #include <cassert>
42 #include <cctype>
43 #include <climits>
44 #include <cstdint>
45 #include <cstdlib>
46
47 #if defined(_MSC_VER)
48 // Disable some silly and noisy warning from MSVC compiler
49 #pragma warning(disable: 4127) // Conditional expression is constant
50 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
51 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
52 #endif
53
54 /// Predefined macros hell:
55 ///
56 /// __GNUC__           Compiler is gcc, Clang or Intel on Linux
57 /// __INTEL_COMPILER   Compiler is Intel
58 /// _MSC_VER           Compiler is MSVC or Intel on Windows
59 /// _WIN32             Building on Windows (any)
60 /// _WIN64             Building on Windows 64 bit
61
62 #if defined(_WIN64) && defined(_MSC_VER) // No Makefile used
63 #  include <intrin.h> // MSVC popcnt and bsfq instrinsics
64 #  define IS_64BIT
65 #  define USE_BSFQ
66 #endif
67
68 #if defined(USE_POPCNT) && defined(__INTEL_COMPILER) && defined(_MSC_VER)
69 #  include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
70 #endif
71
72 #if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
73 #  include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
74 #endif
75
76 #if defined(USE_PEXT)
77 #  include <immintrin.h> // Header for _pext_u64() intrinsic
78 #  define pext(b, m) _pext_u64(b, m)
79 #else
80 #  define pext(b, m) (0)
81 #endif
82
83 #ifdef USE_POPCNT
84 const bool HasPopCnt = true;
85 #else
86 const bool HasPopCnt = false;
87 #endif
88
89 #ifdef USE_PEXT
90 const bool HasPext = true;
91 #else
92 const bool HasPext = false;
93 #endif
94
95 #ifdef IS_64BIT
96 const bool Is64Bit = true;
97 #else
98 const bool Is64Bit = false;
99 #endif
100
101 typedef uint64_t Key;
102 typedef uint64_t Bitboard;
103
104 const int MAX_MOVES = 256;
105 const int MAX_PLY   = 128;
106
107 /// A move needs 16 bits to be stored
108 ///
109 /// bit  0- 5: destination square (from 0 to 63)
110 /// bit  6-11: origin square (from 0 to 63)
111 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
112 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
113 /// NOTE: EN-PASSANT bit is set only when a pawn can be captured
114 ///
115 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
116 /// any normal move destination square is always different from origin square
117 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
118
119 enum Move {
120   MOVE_NONE,
121   MOVE_NULL = 65
122 };
123
124 enum MoveType {
125   NORMAL,
126   PROMOTION = 1 << 14,
127   ENPASSANT = 2 << 14,
128   CASTLING  = 3 << 14
129 };
130
131 enum Color {
132   WHITE, BLACK, NO_COLOR, COLOR_NB = 2
133 };
134
135 enum CastlingSide {
136   KING_SIDE, QUEEN_SIDE, CASTLING_SIDE_NB = 2
137 };
138
139 enum CastlingRight {
140   NO_CASTLING,
141   WHITE_OO,
142   WHITE_OOO = WHITE_OO << 1,
143   BLACK_OO  = WHITE_OO << 2,
144   BLACK_OOO = WHITE_OO << 3,
145   ANY_CASTLING = WHITE_OO | WHITE_OOO | BLACK_OO | BLACK_OOO,
146   CASTLING_RIGHT_NB = 16
147 };
148
149 template<Color C, CastlingSide S> struct MakeCastling {
150   static const CastlingRight
151   right = C == WHITE ? S == QUEEN_SIDE ? WHITE_OOO : WHITE_OO
152                      : S == QUEEN_SIDE ? BLACK_OOO : BLACK_OO;
153 };
154
155 enum Phase {
156   PHASE_ENDGAME,
157   PHASE_MIDGAME = 128,
158   MG = 0, EG = 1, PHASE_NB = 2
159 };
160
161 enum ScaleFactor {
162   SCALE_FACTOR_DRAW    = 0,
163   SCALE_FACTOR_ONEPAWN = 48,
164   SCALE_FACTOR_NORMAL  = 64,
165   SCALE_FACTOR_MAX     = 128,
166   SCALE_FACTOR_NONE    = 255
167 };
168
169 enum Bound {
170   BOUND_NONE,
171   BOUND_UPPER,
172   BOUND_LOWER,
173   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
174 };
175
176 enum Value : int {
177   VALUE_ZERO      = 0,
178   VALUE_DRAW      = 0,
179   VALUE_KNOWN_WIN = 10000,
180   VALUE_MATE      = 32000,
181   VALUE_INFINITE  = 32001,
182   VALUE_NONE      = 32002,
183
184   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - 2 * MAX_PLY,
185   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + 2 * MAX_PLY,
186
187   PawnValueMg   = 198,   PawnValueEg   = 258,
188   KnightValueMg = 817,   KnightValueEg = 846,
189   BishopValueMg = 836,   BishopValueEg = 857,
190   RookValueMg   = 1270,  RookValueEg   = 1281,
191   QueenValueMg  = 2521,  QueenValueEg  = 2558,
192
193   MidgameLimit  = 15581, EndgameLimit  = 3998
194 };
195
196 enum PieceType {
197   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
198   ALL_PIECES = 0,
199   PIECE_TYPE_NB = 8
200 };
201
202 enum Piece {
203   NO_PIECE,
204   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
205   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
206   PIECE_NB = 16
207 };
208
209 enum Depth {
210
211   ONE_PLY = 1,
212
213   DEPTH_ZERO          =  0,
214   DEPTH_QS_CHECKS     =  0,
215   DEPTH_QS_NO_CHECKS  = -1,
216   DEPTH_QS_RECAPTURES = -5,
217
218   DEPTH_NONE = -6,
219   DEPTH_MAX  = MAX_PLY
220 };
221
222 enum Square {
223   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
224   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
225   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
226   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
227   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
228   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
229   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
230   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
231   SQ_NONE,
232
233   SQUARE_NB = 64,
234
235   DELTA_N =  8,
236   DELTA_E =  1,
237   DELTA_S = -8,
238   DELTA_W = -1,
239
240   DELTA_NN = DELTA_N + DELTA_N,
241   DELTA_NE = DELTA_N + DELTA_E,
242   DELTA_SE = DELTA_S + DELTA_E,
243   DELTA_SS = DELTA_S + DELTA_S,
244   DELTA_SW = DELTA_S + DELTA_W,
245   DELTA_NW = DELTA_N + DELTA_W
246 };
247
248 enum File {
249   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
250 };
251
252 enum Rank {
253   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
254 };
255
256
257 /// Score enum stores a middlegame and an endgame value in a single integer
258 /// (enum). The least significant 16 bits are used to store the endgame value
259 /// and the upper 16 bits are used to store the middlegame value.
260 enum Score : int { SCORE_ZERO };
261
262 inline Score make_score(int mg, int eg) {
263   return Score((mg << 16) + eg);
264 }
265
266 /// Extracting the signed lower and upper 16 bits is not so trivial because
267 /// according to the standard a simple cast to short is implementation defined
268 /// and so is a right shift of a signed integer.
269 inline Value mg_value(Score s) {
270
271   union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s + 0x8000) >> 16) };
272   return Value(mg.s);
273 }
274
275 inline Value eg_value(Score s) {
276
277   union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s)) };
278   return Value(eg.s);
279 }
280
281 #define ENABLE_BASE_OPERATORS_ON(T)                             \
282 inline T operator+(T d1, T d2) { return T(int(d1) + int(d2)); } \
283 inline T operator-(T d1, T d2) { return T(int(d1) - int(d2)); } \
284 inline T operator*(int i, T d) { return T(i * int(d)); }        \
285 inline T operator*(T d, int i) { return T(int(d) * i); }        \
286 inline T operator-(T d) { return T(-int(d)); }                  \
287 inline T& operator+=(T& d1, T d2) { return d1 = d1 + d2; }      \
288 inline T& operator-=(T& d1, T d2) { return d1 = d1 - d2; }      \
289 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
290
291 #define ENABLE_FULL_OPERATORS_ON(T)                             \
292 ENABLE_BASE_OPERATORS_ON(T)                                     \
293 inline T& operator++(T& d) { return d = T(int(d) + 1); }        \
294 inline T& operator--(T& d) { return d = T(int(d) - 1); }        \
295 inline T operator/(T d, int i) { return T(int(d) / i); }        \
296 inline int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
297 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
298
299 ENABLE_FULL_OPERATORS_ON(Value)
300 ENABLE_FULL_OPERATORS_ON(PieceType)
301 ENABLE_FULL_OPERATORS_ON(Piece)
302 ENABLE_FULL_OPERATORS_ON(Color)
303 ENABLE_FULL_OPERATORS_ON(Depth)
304 ENABLE_FULL_OPERATORS_ON(Square)
305 ENABLE_FULL_OPERATORS_ON(File)
306 ENABLE_FULL_OPERATORS_ON(Rank)
307
308 ENABLE_BASE_OPERATORS_ON(Score)
309
310 #undef ENABLE_FULL_OPERATORS_ON
311 #undef ENABLE_BASE_OPERATORS_ON
312
313 /// Additional operators to add integers to a Value
314 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
315 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
316 inline Value& operator+=(Value& v, int i) { return v = v + i; }
317 inline Value& operator-=(Value& v, int i) { return v = v - i; }
318
319 /// Only declared but not defined. We don't want to multiply two scores due to
320 /// a very high risk of overflow. So user should explicitly convert to integer.
321 inline Score operator*(Score s1, Score s2);
322
323 /// Division of a Score must be handled separately for each term
324 inline Score operator/(Score s, int i) {
325   return make_score(mg_value(s) / i, eg_value(s) / i);
326 }
327
328 extern Value PieceValue[PHASE_NB][PIECE_NB];
329
330 inline Color operator~(Color c) {
331   return Color(c ^ BLACK);
332 }
333
334 inline Square operator~(Square s) {
335   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
336 }
337
338 inline CastlingRight operator|(Color c, CastlingSide s) {
339   return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
340 }
341
342 inline Value mate_in(int ply) {
343   return VALUE_MATE - ply;
344 }
345
346 inline Value mated_in(int ply) {
347   return -VALUE_MATE + ply;
348 }
349
350 inline Square make_square(File f, Rank r) {
351   return Square((r << 3) | f);
352 }
353
354 inline Piece make_piece(Color c, PieceType pt) {
355   return Piece((c << 3) | pt);
356 }
357
358 inline PieceType type_of(Piece pc)  {
359   return PieceType(pc & 7);
360 }
361
362 inline Color color_of(Piece pc) {
363   assert(pc != NO_PIECE);
364   return Color(pc >> 3);
365 }
366
367 inline bool is_ok(Square s) {
368   return s >= SQ_A1 && s <= SQ_H8;
369 }
370
371 inline File file_of(Square s) {
372   return File(s & 7);
373 }
374
375 inline Rank rank_of(Square s) {
376   return Rank(s >> 3);
377 }
378
379 inline Square relative_square(Color c, Square s) {
380   return Square(s ^ (c * 56));
381 }
382
383 inline Rank relative_rank(Color c, Rank r) {
384   return Rank(r ^ (c * 7));
385 }
386
387 inline Rank relative_rank(Color c, Square s) {
388   return relative_rank(c, rank_of(s));
389 }
390
391 inline bool opposite_colors(Square s1, Square s2) {
392   int s = int(s1) ^ int(s2);
393   return ((s >> 3) ^ s) & 1;
394 }
395
396 inline Square pawn_push(Color c) {
397   return c == WHITE ? DELTA_N : DELTA_S;
398 }
399
400 inline Square from_sq(Move m) {
401   return Square((m >> 6) & 0x3F);
402 }
403
404 inline Square to_sq(Move m) {
405   return Square(m & 0x3F);
406 }
407
408 inline MoveType type_of(Move m) {
409   return MoveType(m & (3 << 14));
410 }
411
412 inline PieceType promotion_type(Move m) {
413   return PieceType(((m >> 12) & 3) + KNIGHT);
414 }
415
416 inline Move make_move(Square from, Square to) {
417   return Move(to | (from << 6));
418 }
419
420 template<MoveType T>
421 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
422   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
423 }
424
425 inline bool is_ok(Move m) {
426   return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
427 }
428
429 #endif // #ifndef TYPES_H_INCLUDED