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.
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'
52 /// Predefined macros hell:
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
60 #if defined(__GNUC__ ) && (__GNUC__ < 9 || (__GNUC__ == 9 && __GNUC_MINOR__ <= 2)) && defined(_WIN32) && !defined(__clang__)
61 #define ALIGNAS_ON_STACK_VARIABLES_BROKEN
64 #define ASSERT_ALIGNED(ptr, alignment) assert(reinterpret_cast<uintptr_t>(ptr) % alignment == 0)
66 #if defined(_WIN64) && defined(_MSC_VER) // No Makefile used
67 # include <intrin.h> // Microsoft header for _BitScanForward64()
71 #if defined(USE_POPCNT) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
72 # include <nmmintrin.h> // Intel and Microsoft header for _mm_popcnt_u64()
75 #if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
76 # include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
80 # include <immintrin.h> // Header for _pext_u64() intrinsic
81 # define pext(b, m) _pext_u64(b, m)
89 constexpr bool HasPopCnt = true;
91 constexpr bool HasPopCnt = false;
95 constexpr bool HasPext = true;
97 constexpr bool HasPext = false;
101 constexpr bool Is64Bit = true;
103 constexpr bool Is64Bit = false;
106 using Key = uint64_t;
107 using Bitboard = uint64_t;
109 constexpr int MAX_MOVES = 256;
110 constexpr int MAX_PLY = 246;
112 /// A move needs 16 bits to be stored
114 /// bit 0- 5: destination square (from 0 to 63)
115 /// bit 6-11: origin square (from 0 to 63)
116 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
117 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
118 /// NOTE: en passant bit is set only when a pawn can be captured
120 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
121 /// any normal move destination square is always different from origin square
122 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
132 EN_PASSANT = 2 << 14,
137 WHITE, BLACK, COLOR_NB = 2
140 enum CastlingRights {
143 WHITE_OOO = WHITE_OO << 1,
144 BLACK_OO = WHITE_OO << 2,
145 BLACK_OOO = WHITE_OO << 3,
147 KING_SIDE = WHITE_OO | BLACK_OO,
148 QUEEN_SIDE = WHITE_OOO | BLACK_OOO,
149 WHITE_CASTLING = WHITE_OO | WHITE_OOO,
150 BLACK_CASTLING = BLACK_OO | BLACK_OOO,
151 ANY_CASTLING = WHITE_CASTLING | BLACK_CASTLING,
153 CASTLING_RIGHT_NB = 16
160 BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
166 VALUE_KNOWN_WIN = 10000,
168 VALUE_INFINITE = 32001,
171 VALUE_TB_WIN_IN_MAX_PLY = VALUE_MATE - 2 * MAX_PLY,
172 VALUE_TB_LOSS_IN_MAX_PLY = -VALUE_TB_WIN_IN_MAX_PLY,
173 VALUE_MATE_IN_MAX_PLY = VALUE_MATE - MAX_PLY,
174 VALUE_MATED_IN_MAX_PLY = -VALUE_MATE_IN_MAX_PLY,
176 // In the code, we make the assumption that these values
177 // are such that non_pawn_material() can be used to uniquely
178 // identify the material on the board.
187 NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
194 W_PAWN = PAWN, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
195 B_PAWN = PAWN + 8, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
199 constexpr Value PieceValue[PIECE_NB] = { VALUE_ZERO, PawnValue, KnightValue, BishopValue, RookValue, QueenValue, VALUE_ZERO, VALUE_ZERO,
200 VALUE_ZERO, PawnValue, KnightValue, BishopValue, RookValue, QueenValue, VALUE_ZERO, VALUE_ZERO };
206 DEPTH_QS_NO_CHECKS = -1,
207 DEPTH_QS_RECAPTURES = -5,
211 DEPTH_OFFSET = -7 // value used only for TT entry occupancy check
215 SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
216 SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
217 SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
218 SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
219 SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
220 SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
221 SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
222 SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
229 enum Direction : int {
235 NORTH_EAST = NORTH + EAST,
236 SOUTH_EAST = SOUTH + EAST,
237 SOUTH_WEST = SOUTH + WEST,
238 NORTH_WEST = NORTH + WEST
242 FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
246 RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
249 // Keep track of what a move changes on the board (used by NNUE)
252 // Number of changed pieces
255 // Max 3 pieces can change in one move. A promotion with capture moves
256 // both the pawn and the captured piece to SQ_NONE and the piece promoted
257 // to from SQ_NONE to the capture square.
260 // From and to squares, which may be SQ_NONE
265 #define ENABLE_BASE_OPERATORS_ON(T) \
266 constexpr T operator+(T d1, int d2) { return T(int(d1) + d2); } \
267 constexpr T operator-(T d1, int d2) { return T(int(d1) - d2); } \
268 constexpr T operator-(T d) { return T(-int(d)); } \
269 inline T& operator+=(T& d1, int d2) { return d1 = d1 + d2; } \
270 inline T& operator-=(T& d1, int d2) { return d1 = d1 - d2; }
272 #define ENABLE_INCR_OPERATORS_ON(T) \
273 inline T& operator++(T& d) { return d = T(int(d) + 1); } \
274 inline T& operator--(T& d) { return d = T(int(d) - 1); }
276 #define ENABLE_FULL_OPERATORS_ON(T) \
277 ENABLE_BASE_OPERATORS_ON(T) \
278 constexpr T operator*(int i, T d) { return T(i * int(d)); } \
279 constexpr T operator*(T d, int i) { return T(int(d) * i); } \
280 constexpr T operator/(T d, int i) { return T(int(d) / i); } \
281 constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); } \
282 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); } \
283 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
285 ENABLE_FULL_OPERATORS_ON(Value)
286 ENABLE_FULL_OPERATORS_ON(Direction)
288 ENABLE_INCR_OPERATORS_ON(PieceType)
289 ENABLE_INCR_OPERATORS_ON(Square)
290 ENABLE_INCR_OPERATORS_ON(File)
291 ENABLE_INCR_OPERATORS_ON(Rank)
293 #undef ENABLE_FULL_OPERATORS_ON
294 #undef ENABLE_INCR_OPERATORS_ON
295 #undef ENABLE_BASE_OPERATORS_ON
297 /// Additional operators to add a Direction to a Square
298 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
299 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
300 inline Square& operator+=(Square& s, Direction d) { return s = s + d; }
301 inline Square& operator-=(Square& s, Direction d) { return s = s - d; }
303 constexpr Color operator~(Color c) {
304 return Color(c ^ BLACK); // Toggle color
307 constexpr Square flip_rank(Square s) { // Swap A1 <-> A8
308 return Square(s ^ SQ_A8);
311 constexpr Square flip_file(Square s) { // Swap A1 <-> H1
312 return Square(s ^ SQ_H1);
315 constexpr Piece operator~(Piece pc) {
316 return Piece(pc ^ 8); // Swap color of piece B_KNIGHT <-> W_KNIGHT
319 constexpr CastlingRights operator&(Color c, CastlingRights cr) {
320 return CastlingRights((c == WHITE ? WHITE_CASTLING : BLACK_CASTLING) & cr);
323 constexpr Value mate_in(int ply) {
324 return VALUE_MATE - ply;
327 constexpr Value mated_in(int ply) {
328 return -VALUE_MATE + ply;
331 constexpr Square make_square(File f, Rank r) {
332 return Square((r << 3) + f);
335 constexpr Piece make_piece(Color c, PieceType pt) {
336 return Piece((c << 3) + pt);
339 constexpr PieceType type_of(Piece pc) {
340 return PieceType(pc & 7);
343 inline Color color_of(Piece pc) {
344 assert(pc != NO_PIECE);
345 return Color(pc >> 3);
348 constexpr bool is_ok(Move m) {
349 return m != MOVE_NONE && m != MOVE_NULL;
352 constexpr bool is_ok(Square s) {
353 return s >= SQ_A1 && s <= SQ_H8;
356 constexpr File file_of(Square s) {
360 constexpr Rank rank_of(Square s) {
364 constexpr Square relative_square(Color c, Square s) {
365 return Square(s ^ (c * 56));
368 constexpr Rank relative_rank(Color c, Rank r) {
369 return Rank(r ^ (c * 7));
372 constexpr Rank relative_rank(Color c, Square s) {
373 return relative_rank(c, rank_of(s));
376 constexpr Direction pawn_push(Color c) {
377 return c == WHITE ? NORTH : SOUTH;
380 constexpr Square from_sq(Move m) {
382 return Square((m >> 6) & 0x3F);
385 constexpr Square to_sq(Move m) {
387 return Square(m & 0x3F);
390 constexpr int from_to(Move m) {
394 constexpr MoveType type_of(Move m) {
395 return MoveType(m & (3 << 14));
398 constexpr PieceType promotion_type(Move m) {
399 return PieceType(((m >> 12) & 3) + KNIGHT);
402 constexpr Move make_move(Square from, Square to) {
403 return Move((from << 6) + to);
407 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
408 return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
411 /// Based on a congruential pseudo random number generator
412 constexpr Key make_key(uint64_t seed) {
413 return seed * 6364136223846793005ULL + 1442695040888963407ULL;
416 } // namespace Stockfish
418 #endif // #ifndef TYPES_H_INCLUDED
420 #include "tune.h" // Global visibility to tuning setup