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-2014 Marco Costalba, Joona Kiiski, Tord Romstad
6 Stockfish is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 Stockfish is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #ifndef TYPES_H_INCLUDED
21 #define TYPES_H_INCLUDED
23 /// For Linux and OSX configuration is done automatically using Makefile. To get
24 /// started type 'make help'.
26 /// For Windows, part of the configuration is detected automatically, but some
27 /// switches need to be set manually:
29 /// -DNDEBUG | Disable debugging mode. Always use this.
31 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. A must if you want
32 /// | the executable to run on some very old machines.
34 /// -DUSE_POPCNT | Add runtime support for use of popcnt asm-instruction. Works
35 /// | only in 64-bit mode. For compiling requires hardware with
45 #define unlikely(x) (x) // For code annotation purposes
47 #if defined(_WIN64) && !defined(IS_64BIT)
48 # include <intrin.h> // MSVC popcnt and bsfq instrinsics
53 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
54 # include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
58 # include <immintrin.h> // Header for _pext_u64() intrinsic
60 # define _pext_u64(b, m) (0)
63 # if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
64 # include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
67 #define CACHE_LINE_SIZE 64
68 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
69 # define CACHE_LINE_ALIGNMENT __declspec(align(CACHE_LINE_SIZE))
71 # define CACHE_LINE_ALIGNMENT __attribute__ ((aligned(CACHE_LINE_SIZE)))
75 # define FORCE_INLINE __forceinline
76 #elif defined(__GNUC__)
77 # define FORCE_INLINE inline __attribute__((always_inline))
79 # define FORCE_INLINE inline
83 const bool HasPopCnt = true;
85 const bool HasPopCnt = false;
89 const bool HasPext = true;
91 const bool HasPext = false;
95 const bool Is64Bit = true;
97 const bool Is64Bit = false;
100 typedef uint64_t Key;
101 typedef uint64_t Bitboard;
103 const int MAX_MOVES = 256;
104 const int MAX_PLY = 120;
105 const int MAX_PLY_PLUS_6 = MAX_PLY + 6;
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, NO_COLOR, COLOR_NB = 2
136 KING_SIDE, QUEEN_SIDE, CASTLING_SIDE_NB = 2
139 enum CastlingRight { // Defined as in PolyGlot book hash key
142 WHITE_OOO = WHITE_OO << 1,
143 BLACK_OO = WHITE_OO << 2,
144 BLACK_OOO = WHITE_OO << 3,
145 ANY_CASTLING = WHITE_OO | WHITE_OOO | BLACK_OO | BLACK_OOO,
146 CASTLING_RIGHT_NB = 16
149 template<Color C, CastlingSide S> struct MakeCastling {
150 static const CastlingRight
151 right = C == WHITE ? S == QUEEN_SIDE ? WHITE_OOO : WHITE_OO
152 : S == QUEEN_SIDE ? BLACK_OOO : BLACK_OO;
158 MG = 0, EG = 1, PHASE_NB = 2
162 SCALE_FACTOR_DRAW = 0,
163 SCALE_FACTOR_ONEPAWN = 48,
164 SCALE_FACTOR_NORMAL = 64,
165 SCALE_FACTOR_MAX = 128,
166 SCALE_FACTOR_NONE = 255
173 BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
179 VALUE_KNOWN_WIN = 10000,
181 VALUE_INFINITE = 32001,
184 VALUE_MATE_IN_MAX_PLY = VALUE_MATE - MAX_PLY,
185 VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
187 VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
188 VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN,
190 PawnValueMg = 198, PawnValueEg = 258,
191 KnightValueMg = 817, KnightValueEg = 846,
192 BishopValueMg = 836, BishopValueEg = 857,
193 RookValueMg = 1270, RookValueEg = 1278,
194 QueenValueMg = 2521, QueenValueEg = 2558
198 NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
205 W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
206 B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
214 DEPTH_ZERO = 0 * ONE_PLY,
215 DEPTH_QS_CHECKS = 0 * ONE_PLY,
216 DEPTH_QS_NO_CHECKS = -1 * ONE_PLY,
217 DEPTH_QS_RECAPTURES = -5 * ONE_PLY,
219 DEPTH_NONE = -127 * ONE_PLY
223 SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
224 SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
225 SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
226 SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
227 SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
228 SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
229 SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
230 SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
240 DELTA_NN = DELTA_N + DELTA_N,
241 DELTA_NE = DELTA_N + DELTA_E,
242 DELTA_SE = DELTA_S + DELTA_E,
243 DELTA_SS = DELTA_S + DELTA_S,
244 DELTA_SW = DELTA_S + DELTA_W,
245 DELTA_NW = DELTA_N + DELTA_W
249 FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
253 RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
257 /// The Score enum stores a middlegame and an endgame value in a single integer
258 /// (enum). The least significant 16 bits are used to store the endgame value
259 /// and the upper 16 bits are used to store the middlegame value. The compiler
260 /// is free to choose the enum type as long as it can store the data, so we
261 /// ensure that Score is an integer type by assigning some big int values.
264 SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
265 SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
268 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
270 /// Extracting the signed lower and upper 16 bits is not so trivial because
271 /// according to the standard a simple cast to short is implementation defined
272 /// and so is a right shift of a signed integer.
273 inline Value mg_value(Score s) { return Value(((s + 0x8000) & ~0xffff) / 0x10000); }
275 /// On Intel 64 bit we have a small speed regression with the standard conforming
276 /// version. Therefore, in this case we use faster code that, although not 100%
277 /// standard compliant, seems to work for Intel and MSVC.
278 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
280 inline Value eg_value(Score s) { return Value(int16_t(s & 0xFFFF)); }
284 inline Value eg_value(Score s) {
285 return Value((int)(unsigned(s) & 0x7FFFU) - (int)(unsigned(s) & 0x8000U));
290 #define ENABLE_SAFE_OPERATORS_ON(T) \
291 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
292 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
293 inline T operator*(int i, const T d) { return T(i * int(d)); } \
294 inline T operator*(const T d, int i) { return T(int(d) * i); } \
295 inline T operator-(const T d) { return T(-int(d)); } \
296 inline T& operator+=(T& d1, const T d2) { return d1 = d1 + d2; } \
297 inline T& operator-=(T& d1, const T d2) { return d1 = d1 - d2; } \
298 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
300 #define ENABLE_OPERATORS_ON(T) ENABLE_SAFE_OPERATORS_ON(T) \
301 inline T& operator++(T& d) { return d = T(int(d) + 1); } \
302 inline T& operator--(T& d) { return d = T(int(d) - 1); } \
303 inline T operator/(const T d, int i) { return T(int(d) / i); } \
304 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
306 ENABLE_OPERATORS_ON(Value)
307 ENABLE_OPERATORS_ON(PieceType)
308 ENABLE_OPERATORS_ON(Piece)
309 ENABLE_OPERATORS_ON(Color)
310 ENABLE_OPERATORS_ON(Depth)
311 ENABLE_OPERATORS_ON(Square)
312 ENABLE_OPERATORS_ON(File)
313 ENABLE_OPERATORS_ON(Rank)
315 /// Additional operators to add integers to a Value
316 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
317 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
319 ENABLE_SAFE_OPERATORS_ON(Score)
321 /// Only declared but not defined. We don't want to multiply two scores due to
322 /// a very high risk of overflow. So user should explicitly convert to integer.
323 inline Score operator*(Score s1, Score s2);
325 /// Division of a Score must be handled separately for each term
326 inline Score operator/(Score s, int i) {
327 return make_score(mg_value(s) / i, eg_value(s) / i);
330 #undef ENABLE_OPERATORS_ON
331 #undef ENABLE_SAFE_OPERATORS_ON
333 extern Value PieceValue[PHASE_NB][PIECE_NB];
340 inline bool operator<(const ExtMove& f, const ExtMove& s) {
341 return f.value < s.value;
344 inline Color operator~(Color c) {
345 return Color(c ^ BLACK);
348 inline Square operator~(Square s) {
349 return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
352 inline CastlingRight operator|(Color c, CastlingSide s) {
353 return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
356 inline Value mate_in(int ply) {
357 return VALUE_MATE - ply;
360 inline Value mated_in(int ply) {
361 return -VALUE_MATE + ply;
364 inline Square make_square(File f, Rank r) {
365 return Square((r << 3) | f);
368 inline Piece make_piece(Color c, PieceType pt) {
369 return Piece((c << 3) | pt);
372 inline PieceType type_of(Piece pc) {
373 return PieceType(pc & 7);
376 inline Color color_of(Piece pc) {
377 assert(pc != NO_PIECE);
378 return Color(pc >> 3);
381 inline bool is_ok(Square s) {
382 return s >= SQ_A1 && s <= SQ_H8;
385 inline File file_of(Square s) {
389 inline Rank rank_of(Square s) {
393 inline Square relative_square(Color c, Square s) {
394 return Square(s ^ (c * 56));
397 inline Rank relative_rank(Color c, Rank r) {
398 return Rank(r ^ (c * 7));
401 inline Rank relative_rank(Color c, Square s) {
402 return relative_rank(c, rank_of(s));
405 inline bool opposite_colors(Square s1, Square s2) {
406 int s = int(s1) ^ int(s2);
407 return ((s >> 3) ^ s) & 1;
410 inline char to_char(File f, bool tolower = true) {
411 return char(f - FILE_A + (tolower ? 'a' : 'A'));
414 inline char to_char(Rank r) {
415 return char(r - RANK_1 + '1');
418 inline Square pawn_push(Color c) {
419 return c == WHITE ? DELTA_N : DELTA_S;
422 inline Square from_sq(Move m) {
423 return Square((m >> 6) & 0x3F);
426 inline Square to_sq(Move m) {
427 return Square(m & 0x3F);
430 inline MoveType type_of(Move m) {
431 return MoveType(m & (3 << 14));
434 inline PieceType promotion_type(Move m) {
435 return PieceType(((m >> 12) & 3) + 2);
438 inline Move make_move(Square from, Square to) {
439 return Move(to | (from << 6));
443 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
444 return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
447 inline bool is_ok(Move m) {
448 return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
453 inline const std::string to_string(Square s) {
454 char ch[] = { to_char(file_of(s)), to_char(rank_of(s)), 0 };
458 #endif // #ifndef TYPES_H_INCLUDED