2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
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.
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.
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/>.
19 #ifndef TYPES_H_INCLUDED
20 #define TYPES_H_INCLUDED
22 /// When compiling with provided Makefile (e.g. for Linux and OSX), configuration
23 /// is done automatically. To get started type 'make help'.
25 /// When Makefile is not used (e.g. with Microsoft Visual Studio) some switches
26 /// need to be set manually:
28 /// -DNDEBUG | Disable debugging mode. Always use this for release.
30 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. You may need this to
31 /// | run on some very old machines.
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.
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.
43 // Disable some silly and noisy warnings from MSVC compiler
44 #pragma warning(disable: 4127) // Conditional expression is constant
45 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
46 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
49 /// Predefined macros hell:
51 /// __GNUC__ Compiler is GCC, Clang or ICX
52 /// __clang__ Compiler is Clang or ICX
53 /// __INTEL_LLVM_COMPILER Compiler is ICX
54 /// _MSC_VER Compiler is MSVC
55 /// _WIN32 Building on Windows (any)
56 /// _WIN64 Building on Windows 64 bit
58 #if defined(__GNUC__ ) && (__GNUC__ < 9 || (__GNUC__ == 9 && __GNUC_MINOR__ <= 2)) && defined(_WIN32) && !defined(__clang__)
59 #define ALIGNAS_ON_STACK_VARIABLES_BROKEN
62 #define ASSERT_ALIGNED(ptr, alignment) assert(reinterpret_cast<uintptr_t>(ptr) % alignment == 0)
64 #if defined(_WIN64) && defined(_MSC_VER) // No Makefile used
65 # include <intrin.h> // Microsoft header for _BitScanForward64()
69 #if defined(USE_POPCNT) && defined(_MSC_VER)
70 # include <nmmintrin.h> // Microsoft header for _mm_popcnt_u64()
73 #if !defined(NO_PREFETCH) && defined(_MSC_VER)
74 # include <xmmintrin.h> // Microsoft header for _mm_prefetch()
78 # include <immintrin.h> // Header for _pext_u64() intrinsic
79 # define pext(b, m) _pext_u64(b, m)
87 constexpr bool HasPopCnt = true;
89 constexpr bool HasPopCnt = false;
93 constexpr bool HasPext = true;
95 constexpr bool HasPext = false;
99 constexpr bool Is64Bit = true;
101 constexpr bool Is64Bit = false;
104 using Key = uint64_t;
105 using Bitboard = uint64_t;
107 constexpr int MAX_MOVES = 256;
108 constexpr int MAX_PLY = 246;
110 /// A move needs 16 bits to be stored
112 /// bit 0- 5: destination square (from 0 to 63)
113 /// bit 6-11: origin square (from 0 to 63)
114 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
115 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
116 /// NOTE: en passant bit is set only when a pawn can be captured
118 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
119 /// any normal move destination square is always different from origin square
120 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
130 EN_PASSANT = 2 << 14,
135 WHITE, BLACK, COLOR_NB = 2
138 enum CastlingRights {
141 WHITE_OOO = WHITE_OO << 1,
142 BLACK_OO = WHITE_OO << 2,
143 BLACK_OOO = WHITE_OO << 3,
145 KING_SIDE = WHITE_OO | BLACK_OO,
146 QUEEN_SIDE = WHITE_OOO | BLACK_OOO,
147 WHITE_CASTLING = WHITE_OO | WHITE_OOO,
148 BLACK_CASTLING = BLACK_OO | BLACK_OOO,
149 ANY_CASTLING = WHITE_CASTLING | BLACK_CASTLING,
151 CASTLING_RIGHT_NB = 16
158 BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
165 VALUE_INFINITE = 32001,
168 VALUE_TB_WIN_IN_MAX_PLY = VALUE_MATE - 2 * MAX_PLY,
169 VALUE_TB_LOSS_IN_MAX_PLY = -VALUE_TB_WIN_IN_MAX_PLY,
170 VALUE_MATE_IN_MAX_PLY = VALUE_MATE - MAX_PLY,
171 VALUE_MATED_IN_MAX_PLY = -VALUE_MATE_IN_MAX_PLY,
173 // In the code, we make the assumption that these values
174 // are such that non_pawn_material() can be used to uniquely
175 // identify the material on the board.
184 NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
191 W_PAWN = PAWN, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
192 B_PAWN = PAWN + 8, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
196 constexpr Value PieceValue[PIECE_NB] = { VALUE_ZERO, PawnValue, KnightValue, BishopValue, RookValue, QueenValue, VALUE_ZERO, VALUE_ZERO,
197 VALUE_ZERO, PawnValue, KnightValue, BishopValue, RookValue, QueenValue, VALUE_ZERO, VALUE_ZERO };
203 DEPTH_QS_NO_CHECKS = -1,
204 DEPTH_QS_RECAPTURES = -5,
208 DEPTH_OFFSET = -7 // value used only for TT entry occupancy check
212 SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
213 SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
214 SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
215 SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
216 SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
217 SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
218 SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
219 SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
226 enum Direction : int {
232 NORTH_EAST = NORTH + EAST,
233 SOUTH_EAST = SOUTH + EAST,
234 SOUTH_WEST = SOUTH + WEST,
235 NORTH_WEST = NORTH + WEST
239 FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
243 RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
246 // Keep track of what a move changes on the board (used by NNUE)
249 // Number of changed pieces
252 // Max 3 pieces can change in one move. A promotion with capture moves
253 // both the pawn and the captured piece to SQ_NONE and the piece promoted
254 // to from SQ_NONE to the capture square.
257 // From and to squares, which may be SQ_NONE
262 #define ENABLE_BASE_OPERATORS_ON(T) \
263 constexpr T operator+(T d1, int d2) { return T(int(d1) + d2); } \
264 constexpr T operator-(T d1, int d2) { return T(int(d1) - d2); } \
265 constexpr T operator-(T d) { return T(-int(d)); } \
266 inline T& operator+=(T& d1, int d2) { return d1 = d1 + d2; } \
267 inline T& operator-=(T& d1, int d2) { return d1 = d1 - d2; }
269 #define ENABLE_INCR_OPERATORS_ON(T) \
270 inline T& operator++(T& d) { return d = T(int(d) + 1); } \
271 inline T& operator--(T& d) { return d = T(int(d) - 1); }
273 #define ENABLE_FULL_OPERATORS_ON(T) \
274 ENABLE_BASE_OPERATORS_ON(T) \
275 constexpr T operator*(int i, T d) { return T(i * int(d)); } \
276 constexpr T operator*(T d, int i) { return T(int(d) * i); } \
277 constexpr T operator/(T d, int i) { return T(int(d) / i); } \
278 constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); } \
279 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); } \
280 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
282 ENABLE_FULL_OPERATORS_ON(Value)
283 ENABLE_FULL_OPERATORS_ON(Direction)
285 ENABLE_INCR_OPERATORS_ON(PieceType)
286 ENABLE_INCR_OPERATORS_ON(Square)
287 ENABLE_INCR_OPERATORS_ON(File)
288 ENABLE_INCR_OPERATORS_ON(Rank)
290 #undef ENABLE_FULL_OPERATORS_ON
291 #undef ENABLE_INCR_OPERATORS_ON
292 #undef ENABLE_BASE_OPERATORS_ON
294 /// Additional operators to add a Direction to a Square
295 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
296 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
297 inline Square& operator+=(Square& s, Direction d) { return s = s + d; }
298 inline Square& operator-=(Square& s, Direction d) { return s = s - d; }
300 constexpr Color operator~(Color c) {
301 return Color(c ^ BLACK); // Toggle color
304 constexpr Square flip_rank(Square s) { // Swap A1 <-> A8
305 return Square(s ^ SQ_A8);
308 constexpr Square flip_file(Square s) { // Swap A1 <-> H1
309 return Square(s ^ SQ_H1);
312 constexpr Piece operator~(Piece pc) {
313 return Piece(pc ^ 8); // Swap color of piece B_KNIGHT <-> W_KNIGHT
316 constexpr CastlingRights operator&(Color c, CastlingRights cr) {
317 return CastlingRights((c == WHITE ? WHITE_CASTLING : BLACK_CASTLING) & cr);
320 constexpr Value mate_in(int ply) {
321 return VALUE_MATE - ply;
324 constexpr Value mated_in(int ply) {
325 return -VALUE_MATE + ply;
328 constexpr Square make_square(File f, Rank r) {
329 return Square((r << 3) + f);
332 constexpr Piece make_piece(Color c, PieceType pt) {
333 return Piece((c << 3) + pt);
336 constexpr PieceType type_of(Piece pc) {
337 return PieceType(pc & 7);
340 inline Color color_of(Piece pc) {
341 assert(pc != NO_PIECE);
342 return Color(pc >> 3);
345 constexpr bool is_ok(Move m) {
346 return m != MOVE_NONE && m != MOVE_NULL;
349 constexpr bool is_ok(Square s) {
350 return s >= SQ_A1 && s <= SQ_H8;
353 constexpr File file_of(Square s) {
357 constexpr Rank rank_of(Square s) {
361 constexpr Square relative_square(Color c, Square s) {
362 return Square(s ^ (c * 56));
365 constexpr Rank relative_rank(Color c, Rank r) {
366 return Rank(r ^ (c * 7));
369 constexpr Rank relative_rank(Color c, Square s) {
370 return relative_rank(c, rank_of(s));
373 constexpr Direction pawn_push(Color c) {
374 return c == WHITE ? NORTH : SOUTH;
377 constexpr Square from_sq(Move m) {
379 return Square((m >> 6) & 0x3F);
382 constexpr Square to_sq(Move m) {
384 return Square(m & 0x3F);
387 constexpr int from_to(Move m) {
391 constexpr MoveType type_of(Move m) {
392 return MoveType(m & (3 << 14));
395 constexpr PieceType promotion_type(Move m) {
396 return PieceType(((m >> 12) & 3) + KNIGHT);
399 constexpr Move make_move(Square from, Square to) {
400 return Move((from << 6) + to);
404 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
405 return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
408 /// Based on a congruential pseudo-random number generator
409 constexpr Key make_key(uint64_t seed) {
410 return seed * 6364136223846793005ULL + 1442695040888963407ULL;
413 } // namespace Stockfish
415 #endif // #ifndef TYPES_H_INCLUDED
417 #include "tune.h" // Global visibility to tuning setup