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-2013 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 #if !defined(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. Use always.
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 #if defined(_WIN64) && !defined(IS_64BIT)
46 # include <intrin.h> // MSVC popcnt and bsfq instrinsics
51 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
52 # include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
55 # if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
56 # include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
59 #define CACHE_LINE_SIZE 64
60 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
61 # define CACHE_LINE_ALIGNMENT __declspec(align(CACHE_LINE_SIZE))
63 # define CACHE_LINE_ALIGNMENT __attribute__ ((aligned(CACHE_LINE_SIZE)))
67 # define FORCE_INLINE __forceinline
68 #elif defined(__GNUC__)
69 # define FORCE_INLINE inline __attribute__((always_inline))
71 # define FORCE_INLINE inline
74 #if defined(USE_POPCNT)
75 const bool HasPopCnt = true;
77 const bool HasPopCnt = false;
81 const bool Is64Bit = true;
83 const bool Is64Bit = false;
87 typedef uint64_t Bitboard;
89 const int MAX_MOVES = 192;
90 const int MAX_PLY = 100;
91 const int MAX_PLY_PLUS_2 = MAX_PLY + 2;
93 const Bitboard FileABB = 0x0101010101010101ULL;
94 const Bitboard FileBBB = FileABB << 1;
95 const Bitboard FileCBB = FileABB << 2;
96 const Bitboard FileDBB = FileABB << 3;
97 const Bitboard FileEBB = FileABB << 4;
98 const Bitboard FileFBB = FileABB << 5;
99 const Bitboard FileGBB = FileABB << 6;
100 const Bitboard FileHBB = FileABB << 7;
102 const Bitboard Rank1BB = 0xFF;
103 const Bitboard Rank2BB = Rank1BB << (8 * 1);
104 const Bitboard Rank3BB = Rank1BB << (8 * 2);
105 const Bitboard Rank4BB = Rank1BB << (8 * 3);
106 const Bitboard Rank5BB = Rank1BB << (8 * 4);
107 const Bitboard Rank6BB = Rank1BB << (8 * 5);
108 const Bitboard Rank7BB = Rank1BB << (8 * 6);
109 const Bitboard Rank8BB = Rank1BB << (8 * 7);
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), castle (3)
119 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
120 /// any normal move destination square is always different from origin square
121 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
135 enum CastleRight { // Defined as in PolyGlot book hash key
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 = 15000,
176 VALUE_INFINITE = 30001,
179 VALUE_MATE_IN_MAX_PLY = VALUE_MATE - MAX_PLY,
180 VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
182 VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
183 VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN,
185 PawnValueMg = 198, PawnValueEg = 258,
186 KnightValueMg = 817, KnightValueEg = 846,
187 BishopValueMg = 836, BishopValueEg = 857,
188 RookValueMg = 1270, RookValueEg = 1278,
189 QueenValueMg = 2521, QueenValueEg = 2558
193 NO_PIECE_TYPE = 0, ALL_PIECES = 0,
194 PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6,
200 W_PAWN = 1, W_KNIGHT = 2, W_BISHOP = 3, W_ROOK = 4, W_QUEEN = 5, W_KING = 6,
201 B_PAWN = 9, B_KNIGHT = 10, B_BISHOP = 11, B_ROOK = 12, B_QUEEN = 13, B_KING = 14,
206 WHITE, BLACK, NO_COLOR, COLOR_NB = 2
213 DEPTH_ZERO = 0 * ONE_PLY,
214 DEPTH_QS_CHECKS = -1 * ONE_PLY,
215 DEPTH_QS_NO_CHECKS = -2 * ONE_PLY,
216 DEPTH_QS_RECAPTURES = -7 * ONE_PLY,
218 DEPTH_NONE = -127 * ONE_PLY
222 SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
223 SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
224 SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
225 SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
226 SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
227 SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
228 SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
229 SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
239 DELTA_NN = DELTA_N + DELTA_N,
240 DELTA_NE = DELTA_N + DELTA_E,
241 DELTA_SE = DELTA_S + DELTA_E,
242 DELTA_SS = DELTA_S + DELTA_S,
243 DELTA_SW = DELTA_S + DELTA_W,
244 DELTA_NW = DELTA_N + DELTA_W
248 FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB = 8
252 RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB = 8
256 /// Score enum keeps a midgame and an endgame value in a single integer (enum),
257 /// first LSB 16 bits are used to store endgame value, while upper bits are used
258 /// for midgame value. Compiler is free to choose the enum type as long as can
259 /// keep its data, so ensure Score to be an integer type.
262 SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
263 SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
266 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
268 /// Extracting the signed lower and upper 16 bits it not so trivial because
269 /// according to the standard a simple cast to short is implementation defined
270 /// and so is a right shift of a signed integer.
271 inline Value mg_value(Score s) { return Value(((s + 0x8000) & ~0xffff) / 0x10000); }
273 /// On Intel 64 bit we have a small speed regression with the standard conforming
274 /// version, so use a faster code in this case that, although not 100% standard
275 /// compliant it seems to work for Intel and MSVC.
276 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
278 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
282 inline Value eg_value(Score s) {
283 return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u));
288 #define ENABLE_SAFE_OPERATORS_ON(T) \
289 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
290 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
291 inline T operator*(int i, const T d) { return T(i * int(d)); } \
292 inline T operator*(const T d, int i) { return T(int(d) * i); } \
293 inline T operator-(const T d) { return T(-int(d)); } \
294 inline T& operator+=(T& d1, const T d2) { d1 = d1 + d2; return d1; } \
295 inline T& operator-=(T& d1, const T d2) { d1 = d1 - d2; return d1; } \
296 inline T& operator*=(T& d, int i) { d = T(int(d) * i); return d; }
298 #define ENABLE_OPERATORS_ON(T) ENABLE_SAFE_OPERATORS_ON(T) \
299 inline T operator++(T& d, int) { d = T(int(d) + 1); return d; } \
300 inline T operator--(T& d, int) { d = T(int(d) - 1); return d; } \
301 inline T operator/(const T d, int i) { return T(int(d) / i); } \
302 inline T& operator/=(T& d, int i) { d = T(int(d) / i); return d; }
304 ENABLE_OPERATORS_ON(Value)
305 ENABLE_OPERATORS_ON(PieceType)
306 ENABLE_OPERATORS_ON(Piece)
307 ENABLE_OPERATORS_ON(Color)
308 ENABLE_OPERATORS_ON(Depth)
309 ENABLE_OPERATORS_ON(Square)
310 ENABLE_OPERATORS_ON(File)
311 ENABLE_OPERATORS_ON(Rank)
313 /// Added operators for adding integers to a Value
314 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
315 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
317 ENABLE_SAFE_OPERATORS_ON(Score)
319 /// Only declared but not defined. We don't want to multiply two scores due to
320 /// a very high risk of overflow. So user should explicitly convert to integer.
321 inline Score operator*(Score s1, Score s2);
323 /// Division of a Score must be handled separately for each term
324 inline Score operator/(Score s, int i) {
325 return make_score(mg_value(s) / i, eg_value(s) / i);
328 #undef ENABLE_OPERATORS_ON
329 #undef ENABLE_SAFE_OPERATORS_ON
333 extern Key psq[COLOR_NB][PIECE_TYPE_NB][SQUARE_NB];
334 extern Key enpassant[FILE_NB];
335 extern Key castle[CASTLE_RIGHT_NB];
337 extern Key exclusion;
344 extern Score pieceSquareTable[PIECE_NB][SQUARE_NB];
345 extern Value PieceValue[PHASE_NB][PIECE_NB];
346 extern int SquareDistance[SQUARE_NB][SQUARE_NB];
353 inline bool operator<(const MoveStack& f, const MoveStack& s) {
354 return f.score < s.score;
357 inline Color operator~(Color c) {
361 inline Square operator~(Square s) {
362 return Square(s ^ 56); // Vertical flip SQ_A1 -> SQ_A8
365 inline Square operator|(File f, Rank r) {
366 return Square((r << 3) | f);
369 inline Value mate_in(int ply) {
370 return VALUE_MATE - ply;
373 inline Value mated_in(int ply) {
374 return -VALUE_MATE + ply;
377 inline Piece make_piece(Color c, PieceType pt) {
378 return Piece((c << 3) | pt);
381 inline CastleRight make_castle_right(Color c, CastlingSide s) {
382 return CastleRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
385 inline PieceType type_of(Piece p) {
386 return PieceType(p & 7);
389 inline Color color_of(Piece p) {
390 assert(p != NO_PIECE);
391 return Color(p >> 3);
394 inline bool is_ok(Square s) {
395 return s >= SQ_A1 && s <= SQ_H8;
398 inline File file_of(Square s) {
402 inline Rank rank_of(Square s) {
406 inline Square mirror(Square s) {
407 return Square(s ^ 7); // Horizontal flip SQ_A1 -> SQ_H1
410 inline Square relative_square(Color c, Square s) {
411 return Square(s ^ (c * 56));
414 inline Rank relative_rank(Color c, Rank r) {
415 return Rank(r ^ (c * 7));
418 inline Rank relative_rank(Color c, Square s) {
419 return relative_rank(c, rank_of(s));
422 inline bool opposite_colors(Square s1, Square s2) {
423 int s = int(s1) ^ int(s2);
424 return ((s >> 3) ^ s) & 1;
427 inline int file_distance(Square s1, Square s2) {
428 return abs(file_of(s1) - file_of(s2));
431 inline int rank_distance(Square s1, Square s2) {
432 return abs(rank_of(s1) - rank_of(s2));
435 inline int square_distance(Square s1, Square s2) {
436 return SquareDistance[s1][s2];
439 inline char file_to_char(File f, bool tolower = true) {
440 return char(f - FILE_A + (tolower ? 'a' : 'A'));
443 inline char rank_to_char(Rank r) {
444 return char(r - RANK_1 + '1');
447 inline Square pawn_push(Color c) {
448 return c == WHITE ? DELTA_N : DELTA_S;
451 inline Square from_sq(Move m) {
452 return Square((m >> 6) & 0x3F);
455 inline Square to_sq(Move m) {
456 return Square(m & 0x3F);
459 inline MoveType type_of(Move m) {
460 return MoveType(m & (3 << 14));
463 inline PieceType promotion_type(Move m) {
464 return PieceType(((m >> 12) & 3) + 2);
467 inline Move make_move(Square from, Square to) {
468 return Move(to | (from << 6));
472 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
473 return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
476 inline bool is_ok(Move m) {
477 return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
482 inline const std::string square_to_string(Square s) {
483 char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
487 #endif // !defined(TYPES_H_INCLUDED)