]> git.sesse.net Git - stockfish/blob - src/types.h
Add tempo also to NNUE eval.
[stockfish] / src / types.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2020 The Stockfish developers (see AUTHORS file)
4
5   Stockfish is free software: you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9
10   Stockfish is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU General Public License for more details.
14
15   You should have received a copy of the GNU General Public License
16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 #ifndef TYPES_H_INCLUDED
20 #define TYPES_H_INCLUDED
21
22 /// When compiling with provided Makefile (e.g. for Linux and OSX), configuration
23 /// is done automatically. To get started type 'make help'.
24 ///
25 /// When Makefile is not used (e.g. with Microsoft Visual Studio) some switches
26 /// need to be set manually:
27 ///
28 /// -DNDEBUG      | Disable debugging mode. Always use this for release.
29 ///
30 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. You may need this to
31 ///               | run on some very old machines.
32 ///
33 /// -DUSE_POPCNT  | Add runtime support for use of popcnt asm-instruction. Works
34 ///               | only in 64-bit mode and requires hardware with popcnt support.
35 ///
36 /// -DUSE_PEXT    | Add runtime support for use of pext asm-instruction. Works
37 ///               | only in 64-bit mode and requires hardware with pext support.
38
39 #include <cassert>
40 #include <cctype>
41 #include <cstdint>
42 #include <cstdlib>
43 #include <algorithm>
44
45 #if defined(_MSC_VER)
46 // Disable some silly and noisy warning from MSVC compiler
47 #pragma warning(disable: 4127) // Conditional expression is constant
48 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
49 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
50 #endif
51
52 /// Predefined macros hell:
53 ///
54 /// __GNUC__           Compiler is gcc, Clang or Intel on Linux
55 /// __INTEL_COMPILER   Compiler is Intel
56 /// _MSC_VER           Compiler is MSVC or Intel on Windows
57 /// _WIN32             Building on Windows (any)
58 /// _WIN64             Building on Windows 64 bit
59
60 #if defined(_WIN64) && defined(_MSC_VER) // No Makefile used
61 #  include <intrin.h> // Microsoft header for _BitScanForward64()
62 #  define IS_64BIT
63 #endif
64
65 #if defined(USE_POPCNT) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
66 #  include <nmmintrin.h> // Intel and Microsoft header for _mm_popcnt_u64()
67 #endif
68
69 #if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
70 #  include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
71 #endif
72
73 #if defined(USE_PEXT)
74 #  include <immintrin.h> // Header for _pext_u64() intrinsic
75 #  define pext(b, m) _pext_u64(b, m)
76 #else
77 #  define pext(b, m) 0
78 #endif
79
80 #ifdef USE_POPCNT
81 constexpr bool HasPopCnt = true;
82 #else
83 constexpr bool HasPopCnt = false;
84 #endif
85
86 #ifdef USE_PEXT
87 constexpr bool HasPext = true;
88 #else
89 constexpr bool HasPext = false;
90 #endif
91
92 #ifdef IS_64BIT
93 constexpr bool Is64Bit = true;
94 #else
95 constexpr bool Is64Bit = false;
96 #endif
97
98 typedef uint64_t Key;
99 typedef uint64_t Bitboard;
100
101 constexpr int MAX_MOVES = 256;
102 constexpr int MAX_PLY   = 246;
103
104 /// A move needs 16 bits to be stored
105 ///
106 /// bit  0- 5: destination square (from 0 to 63)
107 /// bit  6-11: origin square (from 0 to 63)
108 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
109 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
110 /// NOTE: EN-PASSANT bit is set only when a pawn can be captured
111 ///
112 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
113 /// any normal move destination square is always different from origin square
114 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
115
116 enum Move : int {
117   MOVE_NONE,
118   MOVE_NULL = 65
119 };
120
121 enum MoveType {
122   NORMAL,
123   PROMOTION = 1 << 14,
124   ENPASSANT = 2 << 14,
125   CASTLING  = 3 << 14
126 };
127
128 enum Color {
129   WHITE, BLACK, COLOR_NB = 2
130 };
131
132 enum CastlingRights {
133   NO_CASTLING,
134   WHITE_OO,
135   WHITE_OOO = WHITE_OO << 1,
136   BLACK_OO  = WHITE_OO << 2,
137   BLACK_OOO = WHITE_OO << 3,
138
139   KING_SIDE      = WHITE_OO  | BLACK_OO,
140   QUEEN_SIDE     = WHITE_OOO | BLACK_OOO,
141   WHITE_CASTLING = WHITE_OO  | WHITE_OOO,
142   BLACK_CASTLING = BLACK_OO  | BLACK_OOO,
143   ANY_CASTLING   = WHITE_CASTLING | BLACK_CASTLING,
144
145   CASTLING_RIGHT_NB = 16
146 };
147
148 enum Phase {
149   PHASE_ENDGAME,
150   PHASE_MIDGAME = 128,
151   MG = 0, EG = 1, PHASE_NB = 2
152 };
153
154 enum ScaleFactor {
155   SCALE_FACTOR_DRAW    = 0,
156   SCALE_FACTOR_NORMAL  = 64,
157   SCALE_FACTOR_MAX     = 128,
158   SCALE_FACTOR_NONE    = 255
159 };
160
161 enum Bound {
162   BOUND_NONE,
163   BOUND_UPPER,
164   BOUND_LOWER,
165   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
166 };
167
168 enum Value : int {
169   VALUE_ZERO      = 0,
170   VALUE_DRAW      = 0,
171   VALUE_KNOWN_WIN = 10000,
172   VALUE_MATE      = 32000,
173   VALUE_INFINITE  = 32001,
174   VALUE_NONE      = 32002,
175
176   VALUE_TB_WIN_IN_MAX_PLY  =  VALUE_MATE - 2 * MAX_PLY,
177   VALUE_TB_LOSS_IN_MAX_PLY = -VALUE_TB_WIN_IN_MAX_PLY,
178   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
179   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE_IN_MAX_PLY,
180
181   PawnValueMg   = 124,   PawnValueEg   = 206,
182   KnightValueMg = 781,   KnightValueEg = 854,
183   BishopValueMg = 825,   BishopValueEg = 915,
184   RookValueMg   = 1276,  RookValueEg   = 1380,
185   QueenValueMg  = 2538,  QueenValueEg  = 2682,
186   Tempo = 28,
187
188   MidgameLimit  = 15258, EndgameLimit  = 3915
189 };
190
191 enum PieceType {
192   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
193   ALL_PIECES = 0,
194   PIECE_TYPE_NB = 8
195 };
196
197 enum Piece {
198   NO_PIECE,
199   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
200   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
201   PIECE_NB = 16
202 };
203
204 // An ID used to track the pieces. Max. 32 pieces on board.
205 enum PieceId {
206   PIECE_ID_ZERO   = 0,
207   PIECE_ID_KING   = 30,
208   PIECE_ID_WKING  = 30,
209   PIECE_ID_BKING  = 31,
210   PIECE_ID_NONE   = 32
211 };
212
213 inline PieceId operator++(PieceId& d, int) {
214
215   PieceId x = d;
216   d = PieceId(int(d) + 1);
217   return x;
218 }
219
220 constexpr Value PieceValue[PHASE_NB][PIECE_NB] = {
221   { VALUE_ZERO, PawnValueMg, KnightValueMg, BishopValueMg, RookValueMg, QueenValueMg, VALUE_ZERO, VALUE_ZERO,
222     VALUE_ZERO, PawnValueMg, KnightValueMg, BishopValueMg, RookValueMg, QueenValueMg, VALUE_ZERO, VALUE_ZERO },
223   { VALUE_ZERO, PawnValueEg, KnightValueEg, BishopValueEg, RookValueEg, QueenValueEg, VALUE_ZERO, VALUE_ZERO,
224     VALUE_ZERO, PawnValueEg, KnightValueEg, BishopValueEg, RookValueEg, QueenValueEg, VALUE_ZERO, VALUE_ZERO }
225 };
226
227 typedef int Depth;
228
229 enum : int {
230   DEPTH_QS_CHECKS     =  0,
231   DEPTH_QS_NO_CHECKS  = -1,
232   DEPTH_QS_RECAPTURES = -5,
233
234   DEPTH_NONE   = -6,
235   DEPTH_OFFSET = DEPTH_NONE
236 };
237
238 enum Square : int {
239   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
240   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
241   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
242   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
243   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
244   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
245   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
246   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
247   SQ_NONE,
248
249   SQUARE_ZERO = 0,
250   SQUARE_NB   = 64
251 };
252
253 enum Direction : int {
254   NORTH =  8,
255   EAST  =  1,
256   SOUTH = -NORTH,
257   WEST  = -EAST,
258
259   NORTH_EAST = NORTH + EAST,
260   SOUTH_EAST = SOUTH + EAST,
261   SOUTH_WEST = SOUTH + WEST,
262   NORTH_WEST = NORTH + WEST
263 };
264
265 enum File : int {
266   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
267 };
268
269 enum Rank : int {
270   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
271 };
272
273 // unique number for each piece type on each square
274 enum PieceSquare : uint32_t {
275   PS_NONE     =  0,
276   PS_W_PAWN   =  1,
277   PS_B_PAWN   =  1 * SQUARE_NB + 1,
278   PS_W_KNIGHT =  2 * SQUARE_NB + 1,
279   PS_B_KNIGHT =  3 * SQUARE_NB + 1,
280   PS_W_BISHOP =  4 * SQUARE_NB + 1,
281   PS_B_BISHOP =  5 * SQUARE_NB + 1,
282   PS_W_ROOK   =  6 * SQUARE_NB + 1,
283   PS_B_ROOK   =  7 * SQUARE_NB + 1,
284   PS_W_QUEEN  =  8 * SQUARE_NB + 1,
285   PS_B_QUEEN  =  9 * SQUARE_NB + 1,
286   PS_W_KING   = 10 * SQUARE_NB + 1,
287   PS_END      = PS_W_KING, // pieces without kings (pawns included)
288   PS_B_KING   = 11 * SQUARE_NB + 1,
289   PS_END2     = 12 * SQUARE_NB + 1
290 };
291
292 struct ExtPieceSquare {
293   PieceSquare from[COLOR_NB];
294 };
295
296 // Array for finding the PieceSquare corresponding to the piece on the board
297 extern ExtPieceSquare kpp_board_index[PIECE_NB];
298
299 constexpr bool is_ok(PieceId pid);
300 constexpr Square rotate180(Square sq);
301
302 // Structure holding which tracked piece (PieceId) is where (PieceSquare)
303 class EvalList {
304
305 public:
306   // Max. number of pieces without kings is 30 but must be a multiple of 4 in AVX2
307   static const int MAX_LENGTH = 32;
308
309   // Array that holds the piece id for the pieces on the board
310   PieceId piece_id_list[SQUARE_NB];
311
312   // List of pieces, separate from White and Black POV
313   PieceSquare* piece_list_fw() const { return const_cast<PieceSquare*>(pieceListFw); }
314   PieceSquare* piece_list_fb() const { return const_cast<PieceSquare*>(pieceListFb); }
315
316   // Place the piece pc with piece_id on the square sq on the board
317   void put_piece(PieceId piece_id, Square sq, Piece pc)
318   {
319       assert(is_ok(piece_id));
320       if (pc != NO_PIECE)
321       {
322           pieceListFw[piece_id] = PieceSquare(kpp_board_index[pc].from[WHITE] + sq);
323           pieceListFb[piece_id] = PieceSquare(kpp_board_index[pc].from[BLACK] + rotate180(sq));
324           piece_id_list[sq] = piece_id;
325       }
326       else
327       {
328           pieceListFw[piece_id] = PS_NONE;
329           pieceListFb[piece_id] = PS_NONE;
330           piece_id_list[sq] = piece_id;
331       }
332   }
333
334   // Convert the specified piece_id piece to ExtPieceSquare type and return it
335   ExtPieceSquare piece_with_id(PieceId piece_id) const
336   {
337       ExtPieceSquare eps;
338       eps.from[WHITE] = pieceListFw[piece_id];
339       eps.from[BLACK] = pieceListFb[piece_id];
340       return eps;
341   }
342
343 private:
344   PieceSquare pieceListFw[MAX_LENGTH];
345   PieceSquare pieceListFb[MAX_LENGTH];
346 };
347
348 // For differential evaluation of pieces that changed since last turn
349 struct DirtyPiece {
350
351   // Number of changed pieces
352   int dirty_num;
353
354   // The ids of changed pieces, max. 2 pieces can change in one move
355   PieceId pieceId[2];
356
357   // What changed from the piece with that piece number
358   ExtPieceSquare old_piece[2];
359   ExtPieceSquare new_piece[2];
360 };
361
362 /// Score enum stores a middlegame and an endgame value in a single integer (enum).
363 /// The least significant 16 bits are used to store the middlegame value and the
364 /// upper 16 bits are used to store the endgame value. We have to take care to
365 /// avoid left-shifting a signed int to avoid undefined behavior.
366 enum Score : int { SCORE_ZERO };
367
368 constexpr Score make_score(int mg, int eg) {
369   return Score((int)((unsigned int)eg << 16) + mg);
370 }
371
372 /// Extracting the signed lower and upper 16 bits is not so trivial because
373 /// according to the standard a simple cast to short is implementation defined
374 /// and so is a right shift of a signed integer.
375 inline Value eg_value(Score s) {
376   union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s + 0x8000) >> 16) };
377   return Value(eg.s);
378 }
379
380 inline Value mg_value(Score s) {
381   union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s)) };
382   return Value(mg.s);
383 }
384
385 #define ENABLE_BASE_OPERATORS_ON(T)                                \
386 constexpr T operator+(T d1, int d2) { return T(int(d1) + d2); }    \
387 constexpr T operator-(T d1, int d2) { return T(int(d1) - d2); }    \
388 constexpr T operator-(T d) { return T(-int(d)); }                  \
389 inline T& operator+=(T& d1, int d2) { return d1 = d1 + d2; }       \
390 inline T& operator-=(T& d1, int d2) { return d1 = d1 - d2; }
391
392 #define ENABLE_INCR_OPERATORS_ON(T)                                \
393 inline T& operator++(T& d) { return d = T(int(d) + 1); }           \
394 inline T& operator--(T& d) { return d = T(int(d) - 1); }
395
396 #define ENABLE_FULL_OPERATORS_ON(T)                                \
397 ENABLE_BASE_OPERATORS_ON(T)                                        \
398 constexpr T operator*(int i, T d) { return T(i * int(d)); }        \
399 constexpr T operator*(T d, int i) { return T(int(d) * i); }        \
400 constexpr T operator/(T d, int i) { return T(int(d) / i); }        \
401 constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
402 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }    \
403 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
404
405 ENABLE_FULL_OPERATORS_ON(Value)
406 ENABLE_FULL_OPERATORS_ON(Direction)
407
408 ENABLE_INCR_OPERATORS_ON(Piece)
409 ENABLE_INCR_OPERATORS_ON(PieceSquare)
410 ENABLE_INCR_OPERATORS_ON(PieceId)
411 ENABLE_INCR_OPERATORS_ON(PieceType)
412 ENABLE_INCR_OPERATORS_ON(Square)
413 ENABLE_INCR_OPERATORS_ON(File)
414 ENABLE_INCR_OPERATORS_ON(Rank)
415
416 ENABLE_BASE_OPERATORS_ON(Score)
417
418 #undef ENABLE_FULL_OPERATORS_ON
419 #undef ENABLE_INCR_OPERATORS_ON
420 #undef ENABLE_BASE_OPERATORS_ON
421
422 /// Additional operators to add a Direction to a Square
423 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
424 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
425 inline Square& operator+=(Square& s, Direction d) { return s = s + d; }
426 inline Square& operator-=(Square& s, Direction d) { return s = s - d; }
427
428 /// Only declared but not defined. We don't want to multiply two scores due to
429 /// a very high risk of overflow. So user should explicitly convert to integer.
430 Score operator*(Score, Score) = delete;
431
432 /// Division of a Score must be handled separately for each term
433 inline Score operator/(Score s, int i) {
434   return make_score(mg_value(s) / i, eg_value(s) / i);
435 }
436
437 /// Multiplication of a Score by an integer. We check for overflow in debug mode.
438 inline Score operator*(Score s, int i) {
439
440   Score result = Score(int(s) * i);
441
442   assert(eg_value(result) == (i * eg_value(s)));
443   assert(mg_value(result) == (i * mg_value(s)));
444   assert((i == 0) || (result / i) == s);
445
446   return result;
447 }
448
449 /// Multiplication of a Score by a boolean
450 inline Score operator*(Score s, bool b) {
451   return b ? s : SCORE_ZERO;
452 }
453
454 constexpr Color operator~(Color c) {
455   return Color(c ^ BLACK); // Toggle color
456 }
457
458 constexpr Square flip_rank(Square s) { // Swap A1 <-> A8
459   return Square(s ^ SQ_A8);
460 }
461
462 constexpr Square flip_file(Square s) { // Swap A1 <-> H1
463   return Square(s ^ SQ_H1);
464 }
465
466 constexpr Piece operator~(Piece pc) {
467   return Piece(pc ^ 8); // Swap color of piece B_KNIGHT <-> W_KNIGHT
468 }
469
470 constexpr CastlingRights operator&(Color c, CastlingRights cr) {
471   return CastlingRights((c == WHITE ? WHITE_CASTLING : BLACK_CASTLING) & cr);
472 }
473
474 constexpr Value mate_in(int ply) {
475   return VALUE_MATE - ply;
476 }
477
478 constexpr Value mated_in(int ply) {
479   return -VALUE_MATE + ply;
480 }
481
482 constexpr Square make_square(File f, Rank r) {
483   return Square((r << 3) + f);
484 }
485
486 constexpr Piece make_piece(Color c, PieceType pt) {
487   return Piece((c << 3) + pt);
488 }
489
490 constexpr PieceType type_of(Piece pc) {
491   return PieceType(pc & 7);
492 }
493
494 inline Color color_of(Piece pc) {
495   assert(pc != NO_PIECE);
496   return Color(pc >> 3);
497 }
498
499 constexpr bool is_ok(PieceId pid) {
500   return pid < PIECE_ID_NONE;
501 }
502
503 constexpr bool is_ok(Square s) {
504   return s >= SQ_A1 && s <= SQ_H8;
505 }
506
507 constexpr File file_of(Square s) {
508   return File(s & 7);
509 }
510
511 constexpr Rank rank_of(Square s) {
512   return Rank(s >> 3);
513 }
514
515 constexpr Square relative_square(Color c, Square s) {
516   return Square(s ^ (c * 56));
517 }
518
519 constexpr Rank relative_rank(Color c, Rank r) {
520   return Rank(r ^ (c * 7));
521 }
522
523 constexpr Rank relative_rank(Color c, Square s) {
524   return relative_rank(c, rank_of(s));
525 }
526
527 constexpr Direction pawn_push(Color c) {
528   return c == WHITE ? NORTH : SOUTH;
529 }
530
531 constexpr Square from_sq(Move m) {
532   return Square((m >> 6) & 0x3F);
533 }
534
535 constexpr Square to_sq(Move m) {
536   return Square(m & 0x3F);
537 }
538
539 // Return relative square when turning the board 180 degrees
540 constexpr Square rotate180(Square sq) {
541   return (Square)(sq ^ 0x3F);
542 }
543
544 constexpr int from_to(Move m) {
545  return m & 0xFFF;
546 }
547
548 constexpr MoveType type_of(Move m) {
549   return MoveType(m & (3 << 14));
550 }
551
552 constexpr PieceType promotion_type(Move m) {
553   return PieceType(((m >> 12) & 3) + KNIGHT);
554 }
555
556 constexpr Move make_move(Square from, Square to) {
557   return Move((from << 6) + to);
558 }
559
560 constexpr Move reverse_move(Move m) {
561   return make_move(to_sq(m), from_sq(m));
562 }
563
564 template<MoveType T>
565 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
566   return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
567 }
568
569 constexpr bool is_ok(Move m) {
570   return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
571 }
572
573 /// Based on a congruential pseudo random number generator
574 constexpr Key make_key(uint64_t seed) {
575   return seed * 6364136223846793005ULL + 1442695040888963407ULL;
576 }
577
578 #endif // #ifndef TYPES_H_INCLUDED
579
580 #include "tune.h" // Global visibility to tuning setup