Improve move order near the root
[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-2020 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 #include <algorithm>
47
48 #if defined(_MSC_VER)
49 // Disable some silly and noisy warning from MSVC compiler
50 #pragma warning(disable: 4127) // Conditional expression is constant
51 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
52 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
53 #endif
54
55 /// Predefined macros hell:
56 ///
57 /// __GNUC__           Compiler is gcc, Clang or Intel on Linux
58 /// __INTEL_COMPILER   Compiler is Intel
59 /// _MSC_VER           Compiler is MSVC or Intel on Windows
60 /// _WIN32             Building on Windows (any)
61 /// _WIN64             Building on Windows 64 bit
62
63 #if defined(_WIN64) && defined(_MSC_VER) // No Makefile used
64 #  include <intrin.h> // Microsoft header for _BitScanForward64()
65 #  define IS_64BIT
66 #endif
67
68 #if defined(USE_POPCNT) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
69 #  include <nmmintrin.h> // Intel and Microsoft header for _mm_popcnt_u64()
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 constexpr bool HasPopCnt = true;
85 #else
86 constexpr bool HasPopCnt = false;
87 #endif
88
89 #ifdef USE_PEXT
90 constexpr bool HasPext = true;
91 #else
92 constexpr bool HasPext = false;
93 #endif
94
95 #ifdef IS_64BIT
96 constexpr bool Is64Bit = true;
97 #else
98 constexpr bool Is64Bit = false;
99 #endif
100
101 typedef uint64_t Key;
102 typedef uint64_t Bitboard;
103
104 constexpr int MAX_MOVES = 256;
105 constexpr int MAX_PLY   = 246;
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 : int {
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, COLOR_NB = 2
133 };
134
135 enum CastlingRights {
136   NO_CASTLING,
137   WHITE_OO,
138   WHITE_OOO = WHITE_OO << 1,
139   BLACK_OO  = WHITE_OO << 2,
140   BLACK_OOO = WHITE_OO << 3,
141
142   KING_SIDE      = WHITE_OO  | BLACK_OO,
143   QUEEN_SIDE     = WHITE_OOO | BLACK_OOO,
144   WHITE_CASTLING = WHITE_OO  | WHITE_OOO,
145   BLACK_CASTLING = BLACK_OO  | BLACK_OOO,
146   ANY_CASTLING   = WHITE_CASTLING | BLACK_CASTLING,
147
148   CASTLING_RIGHT_NB = 16
149 };
150
151 enum Phase {
152   PHASE_ENDGAME,
153   PHASE_MIDGAME = 128,
154   MG = 0, EG = 1, PHASE_NB = 2
155 };
156
157 enum ScaleFactor {
158   SCALE_FACTOR_DRAW    = 0,
159   SCALE_FACTOR_NORMAL  = 64,
160   SCALE_FACTOR_MAX     = 128,
161   SCALE_FACTOR_NONE    = 255
162 };
163
164 enum Bound {
165   BOUND_NONE,
166   BOUND_UPPER,
167   BOUND_LOWER,
168   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
169 };
170
171 enum Value : int {
172   VALUE_ZERO      = 0,
173   VALUE_DRAW      = 0,
174   VALUE_KNOWN_WIN = 10000,
175   VALUE_MATE      = 32000,
176   VALUE_INFINITE  = 32001,
177   VALUE_NONE      = 32002,
178
179   VALUE_TB_WIN_IN_MAX_PLY  =  VALUE_MATE - 2 * MAX_PLY,
180   VALUE_TB_LOSS_IN_MAX_PLY = -VALUE_MATE + 2 * MAX_PLY,
181   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
182   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
183
184   PawnValueMg   = 128,   PawnValueEg   = 213,
185   KnightValueMg = 781,   KnightValueEg = 854,
186   BishopValueMg = 825,   BishopValueEg = 915,
187   RookValueMg   = 1276,  RookValueEg   = 1380,
188   QueenValueMg  = 2538,  QueenValueEg  = 2682,
189
190   MidgameLimit  = 15258, EndgameLimit  = 3915
191 };
192
193 enum PieceType {
194   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
195   ALL_PIECES = 0,
196   PIECE_TYPE_NB = 8
197 };
198
199 enum Piece {
200   NO_PIECE,
201   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
202   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
203   PIECE_NB = 16
204 };
205
206 extern Value PieceValue[PHASE_NB][PIECE_NB];
207
208 typedef int Depth;
209
210 enum : int {
211
212   DEPTH_QS_CHECKS     =  0,
213   DEPTH_QS_NO_CHECKS  = -1,
214   DEPTH_QS_RECAPTURES = -5,
215
216   DEPTH_NONE   = -6,
217   DEPTH_OFFSET = DEPTH_NONE,
218 };
219
220 enum Square : int {
221   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
222   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
223   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
224   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
225   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
226   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
227   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
228   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
229   SQ_NONE,
230
231   SQUARE_NB = 64
232 };
233
234 enum Direction : int {
235   NORTH =  8,
236   EAST  =  1,
237   SOUTH = -NORTH,
238   WEST  = -EAST,
239
240   NORTH_EAST = NORTH + EAST,
241   SOUTH_EAST = SOUTH + EAST,
242   SOUTH_WEST = SOUTH + WEST,
243   NORTH_WEST = NORTH + WEST
244 };
245
246 enum File : int {
247   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
248 };
249
250 enum Rank : int {
251   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
252 };
253
254
255 /// Score enum stores a middlegame and an endgame value in a single integer (enum).
256 /// The least significant 16 bits are used to store the middlegame value and the
257 /// upper 16 bits are used to store the endgame value. We have to take care to
258 /// avoid left-shifting a signed int to avoid undefined behavior.
259 enum Score : int { SCORE_ZERO };
260
261 constexpr Score make_score(int mg, int eg) {
262   return Score((int)((unsigned int)eg << 16) + mg);
263 }
264
265 /// Extracting the signed lower and upper 16 bits is not so trivial because
266 /// according to the standard a simple cast to short is implementation defined
267 /// and so is a right shift of a signed integer.
268 inline Value eg_value(Score s) {
269   union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s + 0x8000) >> 16) };
270   return Value(eg.s);
271 }
272
273 inline Value mg_value(Score s) {
274   union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s)) };
275   return Value(mg.s);
276 }
277
278 #define ENABLE_BASE_OPERATORS_ON(T)                                \
279 constexpr T operator+(T d1, T d2) { return T(int(d1) + int(d2)); } \
280 constexpr T operator-(T d1, T d2) { return T(int(d1) - int(d2)); } \
281 constexpr T operator-(T d) { return T(-int(d)); }                  \
282 inline T& operator+=(T& d1, T d2) { return d1 = d1 + d2; }         \
283 inline T& operator-=(T& d1, T d2) { return d1 = d1 - d2; }
284
285 #define ENABLE_INCR_OPERATORS_ON(T)                                \
286 inline T& operator++(T& d) { return d = T(int(d) + 1); }           \
287 inline T& operator--(T& d) { return d = T(int(d) - 1); }
288
289 #define ENABLE_FULL_OPERATORS_ON(T)                                \
290 ENABLE_BASE_OPERATORS_ON(T)                                        \
291 constexpr T operator*(int i, T d) { return T(i * int(d)); }        \
292 constexpr T operator*(T d, int i) { return T(int(d) * i); }        \
293 constexpr T operator/(T d, int i) { return T(int(d) / i); }        \
294 constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
295 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }    \
296 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
297
298 ENABLE_FULL_OPERATORS_ON(Value)
299 ENABLE_FULL_OPERATORS_ON(Direction)
300
301 ENABLE_INCR_OPERATORS_ON(PieceType)
302 ENABLE_INCR_OPERATORS_ON(Piece)
303 ENABLE_INCR_OPERATORS_ON(Square)
304 ENABLE_INCR_OPERATORS_ON(File)
305 ENABLE_INCR_OPERATORS_ON(Rank)
306
307 ENABLE_BASE_OPERATORS_ON(Score)
308
309 #undef ENABLE_FULL_OPERATORS_ON
310 #undef ENABLE_INCR_OPERATORS_ON
311 #undef ENABLE_BASE_OPERATORS_ON
312
313 /// Additional operators to add integers to a Value
314 constexpr Value operator+(Value v, int i) { return Value(int(v) + i); }
315 constexpr 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 /// Additional operators to add a Direction to a Square
320 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
321 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
322 inline Square& operator+=(Square& s, Direction d) { return s = s + d; }
323 inline Square& operator-=(Square& s, Direction d) { return s = s - d; }
324
325 /// Only declared but not defined. We don't want to multiply two scores due to
326 /// a very high risk of overflow. So user should explicitly convert to integer.
327 Score operator*(Score, Score) = delete;
328
329 /// Division of a Score must be handled separately for each term
330 inline Score operator/(Score s, int i) {
331   return make_score(mg_value(s) / i, eg_value(s) / i);
332 }
333
334 /// Multiplication of a Score by an integer. We check for overflow in debug mode.
335 inline Score operator*(Score s, int i) {
336
337   Score result = Score(int(s) * i);
338
339   assert(eg_value(result) == (i * eg_value(s)));
340   assert(mg_value(result) == (i * mg_value(s)));
341   assert((i == 0) || (result / i) == s);
342
343   return result;
344 }
345
346 /// Multiplication of a Score by a boolean
347 inline Score operator*(Score s, bool b) {
348   return Score(int(s) * int(b));
349 }
350
351 constexpr Color operator~(Color c) {
352   return Color(c ^ BLACK); // Toggle color
353 }
354
355 constexpr Square operator~(Square s) {
356   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
357 }
358
359 constexpr Piece operator~(Piece pc) {
360   return Piece(pc ^ 8); // Swap color of piece B_KNIGHT -> W_KNIGHT
361 }
362
363 inline File map_to_queenside(File f) {
364   return std::min(f, File(FILE_H - f)); // Map files ABCDEFGH to files ABCDDCBA
365 }
366
367 constexpr CastlingRights operator&(Color c, CastlingRights cr) {
368   return CastlingRights((c == WHITE ? WHITE_CASTLING : BLACK_CASTLING) & cr);
369 }
370
371 constexpr Value mate_in(int ply) {
372   return VALUE_MATE - ply;
373 }
374
375 constexpr Value mated_in(int ply) {
376   return -VALUE_MATE + ply;
377 }
378
379 constexpr Square make_square(File f, Rank r) {
380   return Square((r << 3) + f);
381 }
382
383 constexpr Piece make_piece(Color c, PieceType pt) {
384   return Piece((c << 3) + pt);
385 }
386
387 constexpr PieceType type_of(Piece pc) {
388   return PieceType(pc & 7);
389 }
390
391 inline Color color_of(Piece pc) {
392   assert(pc != NO_PIECE);
393   return Color(pc >> 3);
394 }
395
396 constexpr bool is_ok(Square s) {
397   return s >= SQ_A1 && s <= SQ_H8;
398 }
399
400 constexpr File file_of(Square s) {
401   return File(s & 7);
402 }
403
404 constexpr Rank rank_of(Square s) {
405   return Rank(s >> 3);
406 }
407
408 constexpr Square relative_square(Color c, Square s) {
409   return Square(s ^ (c * 56));
410 }
411
412 constexpr Rank relative_rank(Color c, Rank r) {
413   return Rank(r ^ (c * 7));
414 }
415
416 constexpr Rank relative_rank(Color c, Square s) {
417   return relative_rank(c, rank_of(s));
418 }
419
420 constexpr Direction pawn_push(Color c) {
421   return c == WHITE ? NORTH : SOUTH;
422 }
423
424 constexpr Square from_sq(Move m) {
425   return Square((m >> 6) & 0x3F);
426 }
427
428 constexpr Square to_sq(Move m) {
429   return Square(m & 0x3F);
430 }
431
432 constexpr int from_to(Move m) {
433  return m & 0xFFF;
434 }
435
436 constexpr MoveType type_of(Move m) {
437   return MoveType(m & (3 << 14));
438 }
439
440 constexpr PieceType promotion_type(Move m) {
441   return PieceType(((m >> 12) & 3) + KNIGHT);
442 }
443
444 constexpr Move make_move(Square from, Square to) {
445   return Move((from << 6) + to);
446 }
447
448 constexpr Move reverse_move(Move m) {
449   return make_move(to_sq(m), from_sq(m));
450 }
451
452 template<MoveType T>
453 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
454   return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
455 }
456
457 constexpr bool is_ok(Move m) {
458   return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
459 }
460
461 #endif // #ifndef TYPES_H_INCLUDED