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
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.
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.
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/>.
21 #ifndef TYPES_H_INCLUDED
22 #define TYPES_H_INCLUDED
24 /// When compiling with provided Makefile (e.g. for Linux and OSX), configuration
25 /// is done automatically. To get started type 'make help'.
27 /// When Makefile is not used (e.g. with Microsoft Visual Studio) some switches
28 /// need to be set manually:
30 /// -DNDEBUG | Disable debugging mode. Always use this for release.
32 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. You may need this to
33 /// | run on some very old machines.
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.
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.
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'
55 /// Predefined macros hell:
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
63 #if defined(_WIN64) && defined(_MSC_VER) // No Makefile used
64 # include <intrin.h> // Microsoft header for _BitScanForward64()
68 #if defined(USE_POPCNT) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
69 # include <nmmintrin.h> // Intel and Microsoft header for _mm_popcnt_u64()
72 #if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
73 # include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
77 # include <immintrin.h> // Header for _pext_u64() intrinsic
78 # define pext(b, m) _pext_u64(b, m)
84 constexpr bool HasPopCnt = true;
86 constexpr bool HasPopCnt = false;
90 constexpr bool HasPext = true;
92 constexpr bool HasPext = false;
96 constexpr bool Is64Bit = true;
98 constexpr bool Is64Bit = false;
101 typedef uint64_t Key;
102 typedef uint64_t Bitboard;
104 constexpr int MAX_MOVES = 256;
105 constexpr int MAX_PLY = 246;
107 /// A move needs 16 bits to be stored
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
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.
132 WHITE, BLACK, COLOR_NB = 2
135 enum CastlingRights {
138 WHITE_OOO = WHITE_OO << 1,
139 BLACK_OO = WHITE_OO << 2,
140 BLACK_OOO = WHITE_OO << 3,
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,
148 CASTLING_RIGHT_NB = 16
154 MG = 0, EG = 1, PHASE_NB = 2
158 SCALE_FACTOR_DRAW = 0,
159 SCALE_FACTOR_NORMAL = 64,
160 SCALE_FACTOR_MAX = 128,
161 SCALE_FACTOR_NONE = 255
168 BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
174 VALUE_KNOWN_WIN = 10000,
176 VALUE_INFINITE = 32001,
179 VALUE_TB_WIN_IN_MAX_PLY = VALUE_MATE - 2 * MAX_PLY,
180 VALUE_TB_LOSS_IN_MAX_PLY = -VALUE_TB_WIN_IN_MAX_PLY,
181 VALUE_MATE_IN_MAX_PLY = VALUE_MATE - MAX_PLY,
182 VALUE_MATED_IN_MAX_PLY = -VALUE_MATE_IN_MAX_PLY,
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,
191 MidgameLimit = 15258, EndgameLimit = 3915
195 NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
202 W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
203 B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
207 constexpr Value PieceValue[PHASE_NB][PIECE_NB] = {
208 { VALUE_ZERO, PawnValueMg, KnightValueMg, BishopValueMg, RookValueMg, QueenValueMg, VALUE_ZERO, VALUE_ZERO,
209 VALUE_ZERO, PawnValueMg, KnightValueMg, BishopValueMg, RookValueMg, QueenValueMg, VALUE_ZERO, VALUE_ZERO },
210 { VALUE_ZERO, PawnValueEg, KnightValueEg, BishopValueEg, RookValueEg, QueenValueEg, VALUE_ZERO, VALUE_ZERO,
211 VALUE_ZERO, PawnValueEg, KnightValueEg, BishopValueEg, RookValueEg, QueenValueEg, VALUE_ZERO, VALUE_ZERO }
219 DEPTH_QS_NO_CHECKS = -1,
220 DEPTH_QS_RECAPTURES = -5,
223 DEPTH_OFFSET = DEPTH_NONE
227 SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
228 SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
229 SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
230 SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
231 SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
232 SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
233 SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
234 SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
240 enum Direction : int {
246 NORTH_EAST = NORTH + EAST,
247 SOUTH_EAST = SOUTH + EAST,
248 SOUTH_WEST = SOUTH + WEST,
249 NORTH_WEST = NORTH + WEST
253 FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
257 RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
261 /// Score enum stores a middlegame and an endgame value in a single integer (enum).
262 /// The least significant 16 bits are used to store the middlegame value and the
263 /// upper 16 bits are used to store the endgame value. We have to take care to
264 /// avoid left-shifting a signed int to avoid undefined behavior.
265 enum Score : int { SCORE_ZERO };
267 constexpr Score make_score(int mg, int eg) {
268 return Score((int)((unsigned int)eg << 16) + mg);
271 /// Extracting the signed lower and upper 16 bits is not so trivial because
272 /// according to the standard a simple cast to short is implementation defined
273 /// and so is a right shift of a signed integer.
274 inline Value eg_value(Score s) {
275 union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s + 0x8000) >> 16) };
279 inline Value mg_value(Score s) {
280 union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s)) };
284 #define ENABLE_BASE_OPERATORS_ON(T) \
285 constexpr T operator+(T d1, T d2) { return T(int(d1) + int(d2)); } \
286 constexpr T operator-(T d1, T d2) { return T(int(d1) - int(d2)); } \
287 constexpr T operator-(T d) { return T(-int(d)); } \
288 inline T& operator+=(T& d1, T d2) { return d1 = d1 + d2; } \
289 inline T& operator-=(T& d1, T d2) { return d1 = d1 - d2; }
291 #define ENABLE_INCR_OPERATORS_ON(T) \
292 inline T& operator++(T& d) { return d = T(int(d) + 1); } \
293 inline T& operator--(T& d) { return d = T(int(d) - 1); }
295 #define ENABLE_FULL_OPERATORS_ON(T) \
296 ENABLE_BASE_OPERATORS_ON(T) \
297 constexpr T operator*(int i, T d) { return T(i * int(d)); } \
298 constexpr T operator*(T d, int i) { return T(int(d) * i); } \
299 constexpr T operator/(T d, int i) { return T(int(d) / i); } \
300 constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); } \
301 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); } \
302 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
304 ENABLE_FULL_OPERATORS_ON(Value)
305 ENABLE_FULL_OPERATORS_ON(Direction)
307 ENABLE_INCR_OPERATORS_ON(PieceType)
308 ENABLE_INCR_OPERATORS_ON(Piece)
309 ENABLE_INCR_OPERATORS_ON(Square)
310 ENABLE_INCR_OPERATORS_ON(File)
311 ENABLE_INCR_OPERATORS_ON(Rank)
313 ENABLE_BASE_OPERATORS_ON(Score)
315 #undef ENABLE_FULL_OPERATORS_ON
316 #undef ENABLE_INCR_OPERATORS_ON
317 #undef ENABLE_BASE_OPERATORS_ON
319 /// Additional operators to add integers to a Value
320 constexpr Value operator+(Value v, int i) { return Value(int(v) + i); }
321 constexpr Value operator-(Value v, int i) { return Value(int(v) - i); }
322 inline Value& operator+=(Value& v, int i) { return v = v + i; }
323 inline Value& operator-=(Value& v, int i) { return v = v - i; }
325 /// Additional operators to add a Direction to a Square
326 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
327 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
328 inline Square& operator+=(Square& s, Direction d) { return s = s + d; }
329 inline Square& operator-=(Square& s, Direction d) { return s = s - d; }
331 /// Only declared but not defined. We don't want to multiply two scores due to
332 /// a very high risk of overflow. So user should explicitly convert to integer.
333 Score operator*(Score, Score) = delete;
335 /// Division of a Score must be handled separately for each term
336 inline Score operator/(Score s, int i) {
337 return make_score(mg_value(s) / i, eg_value(s) / i);
340 /// Multiplication of a Score by an integer. We check for overflow in debug mode.
341 inline Score operator*(Score s, int i) {
343 Score result = Score(int(s) * i);
345 assert(eg_value(result) == (i * eg_value(s)));
346 assert(mg_value(result) == (i * mg_value(s)));
347 assert((i == 0) || (result / i) == s);
352 /// Multiplication of a Score by a boolean
353 inline Score operator*(Score s, bool b) {
354 return b ? s : SCORE_ZERO;
357 constexpr Color operator~(Color c) {
358 return Color(c ^ BLACK); // Toggle color
361 constexpr Square flip_rank(Square s) {
362 return Square(s ^ SQ_A8);
365 constexpr Square flip_file(Square s) {
366 return Square(s ^ SQ_H1);
369 constexpr Piece operator~(Piece pc) {
370 return Piece(pc ^ 8); // Swap color of piece B_KNIGHT -> W_KNIGHT
373 constexpr CastlingRights operator&(Color c, CastlingRights cr) {
374 return CastlingRights((c == WHITE ? WHITE_CASTLING : BLACK_CASTLING) & cr);
377 constexpr Value mate_in(int ply) {
378 return VALUE_MATE - ply;
381 constexpr Value mated_in(int ply) {
382 return -VALUE_MATE + ply;
385 constexpr Square make_square(File f, Rank r) {
386 return Square((r << 3) + f);
389 constexpr Piece make_piece(Color c, PieceType pt) {
390 return Piece((c << 3) + pt);
393 constexpr PieceType type_of(Piece pc) {
394 return PieceType(pc & 7);
397 inline Color color_of(Piece pc) {
398 assert(pc != NO_PIECE);
399 return Color(pc >> 3);
402 constexpr bool is_ok(Square s) {
403 return s >= SQ_A1 && s <= SQ_H8;
406 constexpr File file_of(Square s) {
410 constexpr Rank rank_of(Square s) {
414 constexpr Square relative_square(Color c, Square s) {
415 return Square(s ^ (c * 56));
418 constexpr Rank relative_rank(Color c, Rank r) {
419 return Rank(r ^ (c * 7));
422 constexpr Rank relative_rank(Color c, Square s) {
423 return relative_rank(c, rank_of(s));
426 constexpr Direction pawn_push(Color c) {
427 return c == WHITE ? NORTH : SOUTH;
430 constexpr Square from_sq(Move m) {
431 return Square((m >> 6) & 0x3F);
434 constexpr Square to_sq(Move m) {
435 return Square(m & 0x3F);
438 constexpr int from_to(Move m) {
442 constexpr MoveType type_of(Move m) {
443 return MoveType(m & (3 << 14));
446 constexpr PieceType promotion_type(Move m) {
447 return PieceType(((m >> 12) & 3) + KNIGHT);
450 constexpr Move make_move(Square from, Square to) {
451 return Move((from << 6) + to);
454 constexpr Move reverse_move(Move m) {
455 return make_move(to_sq(m), from_sq(m));
459 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
460 return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
463 constexpr bool is_ok(Move m) {
464 return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
467 #endif // #ifndef TYPES_H_INCLUDED