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-2012 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
44 #if defined(_WIN64) && !defined(IS_64BIT)
45 # include <intrin.h> // MSVC popcnt and bsfq instrinsics
50 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
51 # include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
54 # if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
55 # include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
58 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
59 # define CACHE_LINE_ALIGNMENT __declspec(align(64))
61 # define CACHE_LINE_ALIGNMENT __attribute__ ((aligned(64)))
65 # define FORCE_INLINE __forceinline
66 #elif defined(__GNUC__)
67 # define FORCE_INLINE inline __attribute__((always_inline))
69 # define FORCE_INLINE inline
72 #if defined(USE_POPCNT)
73 const bool HasPopCnt = true;
75 const bool HasPopCnt = false;
79 const bool Is64Bit = true;
81 const bool Is64Bit = false;
85 typedef uint64_t Bitboard;
87 const int MAX_MOVES = 192;
88 const int MAX_PLY = 100;
89 const int MAX_PLY_PLUS_2 = MAX_PLY + 2;
91 const Bitboard FileABB = 0x0101010101010101ULL;
92 const Bitboard FileBBB = FileABB << 1;
93 const Bitboard FileCBB = FileABB << 2;
94 const Bitboard FileDBB = FileABB << 3;
95 const Bitboard FileEBB = FileABB << 4;
96 const Bitboard FileFBB = FileABB << 5;
97 const Bitboard FileGBB = FileABB << 6;
98 const Bitboard FileHBB = FileABB << 7;
100 const Bitboard Rank1BB = 0xFF;
101 const Bitboard Rank2BB = Rank1BB << (8 * 1);
102 const Bitboard Rank3BB = Rank1BB << (8 * 2);
103 const Bitboard Rank4BB = Rank1BB << (8 * 3);
104 const Bitboard Rank5BB = Rank1BB << (8 * 4);
105 const Bitboard Rank6BB = Rank1BB << (8 * 5);
106 const Bitboard Rank7BB = Rank1BB << (8 * 6);
107 const Bitboard Rank8BB = Rank1BB << (8 * 7);
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), castle (3)
117 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
118 /// any normal move destination square is always different from origin square
119 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
139 enum CastleRight { // Defined as in PolyGlot book hash key
158 MG = 0, EG = 1, PHASE_NB = 2
162 SCALE_FACTOR_DRAW = 0,
163 SCALE_FACTOR_NORMAL = 64,
164 SCALE_FACTOR_MAX = 128,
165 SCALE_FACTOR_NONE = 255
172 BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
178 VALUE_KNOWN_WIN = 15000,
180 VALUE_INFINITE = 30001,
183 VALUE_MATE_IN_MAX_PLY = VALUE_MATE - MAX_PLY,
184 VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
186 VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
187 VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN,
189 PawnValueMg = 198, PawnValueEg = 258,
190 KnightValueMg = 817, KnightValueEg = 846,
191 BishopValueMg = 836, BishopValueEg = 857,
192 RookValueMg = 1270, RookValueEg = 1278,
193 QueenValueMg = 2521, QueenValueEg = 2558
197 NO_PIECE_TYPE = 0, ALL_PIECES = 0,
198 PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6,
204 W_PAWN = 1, W_KNIGHT = 2, W_BISHOP = 3, W_ROOK = 4, W_QUEEN = 5, W_KING = 6,
205 B_PAWN = 9, B_KNIGHT = 10, B_BISHOP = 11, B_ROOK = 12, B_QUEEN = 13, B_KING = 14,
210 WHITE, BLACK, NO_COLOR, COLOR_NB = 2
217 DEPTH_ZERO = 0 * ONE_PLY,
218 DEPTH_QS_CHECKS = -1 * ONE_PLY,
219 DEPTH_QS_NO_CHECKS = -2 * ONE_PLY,
220 DEPTH_QS_RECAPTURES = -5 * ONE_PLY,
222 DEPTH_NONE = -127 * ONE_PLY
226 SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
227 SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
228 SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
229 SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
230 SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
231 SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
232 SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
233 SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
243 DELTA_NN = DELTA_N + DELTA_N,
244 DELTA_NE = DELTA_N + DELTA_E,
245 DELTA_SE = DELTA_S + DELTA_E,
246 DELTA_SS = DELTA_S + DELTA_S,
247 DELTA_SW = DELTA_S + DELTA_W,
248 DELTA_NW = DELTA_N + DELTA_W
252 FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB = 8
256 RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB = 8
260 /// Score enum keeps a midgame and an endgame value in a single integer (enum),
261 /// first LSB 16 bits are used to store endgame value, while upper bits are used
262 /// for midgame value. Compiler is free to choose the enum type as long as can
263 /// keep its data, so ensure Score to be an integer type.
266 SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
267 SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
270 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
272 /// Extracting the signed lower and upper 16 bits it not so trivial because
273 /// according to the standard a simple cast to short is implementation defined
274 /// and so is a right shift of a signed integer.
275 inline Value mg_value(Score s) { return Value(((s + 32768) & ~0xffff) / 0x10000); }
277 /// On Intel 64 bit we have a small speed regression with the standard conforming
278 /// version, so use a faster code in this case that, although not 100% standard
279 /// compliant it seems to work for Intel and MSVC.
280 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
282 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
286 inline Value eg_value(Score s) {
287 return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u));
292 #define ENABLE_SAFE_OPERATORS_ON(T) \
293 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
294 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
295 inline T operator*(int i, const T d) { return T(i * int(d)); } \
296 inline T operator*(const T d, int i) { return T(int(d) * i); } \
297 inline T operator-(const T d) { return T(-int(d)); } \
298 inline T& operator+=(T& d1, const T d2) { d1 = d1 + d2; return d1; } \
299 inline T& operator-=(T& d1, const T d2) { d1 = d1 - d2; return d1; } \
300 inline T& operator*=(T& d, int i) { d = T(int(d) * i); return d; }
302 #define ENABLE_OPERATORS_ON(T) ENABLE_SAFE_OPERATORS_ON(T) \
303 inline T operator++(T& d, int) { d = T(int(d) + 1); return d; } \
304 inline T operator--(T& d, int) { d = T(int(d) - 1); return d; } \
305 inline T operator/(const T d, int i) { return T(int(d) / i); } \
306 inline T& operator/=(T& d, int i) { d = T(int(d) / i); return d; }
308 ENABLE_OPERATORS_ON(Value)
309 ENABLE_OPERATORS_ON(PieceType)
310 ENABLE_OPERATORS_ON(Piece)
311 ENABLE_OPERATORS_ON(Color)
312 ENABLE_OPERATORS_ON(Depth)
313 ENABLE_OPERATORS_ON(Square)
314 ENABLE_OPERATORS_ON(File)
315 ENABLE_OPERATORS_ON(Rank)
317 /// Added operators for adding integers to a Value
318 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
319 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
321 ENABLE_SAFE_OPERATORS_ON(Score)
323 /// Only declared but not defined. We don't want to multiply two scores due to
324 /// a very high risk of overflow. So user should explicitly convert to integer.
325 inline Score operator*(Score s1, Score s2);
327 /// Division of a Score must be handled separately for each term
328 inline Score operator/(Score s, int i) {
329 return make_score(mg_value(s) / i, eg_value(s) / i);
332 /// Weight score v by score w trying to prevent overflow
333 inline Score apply_weight(Score v, Score w) {
334 return make_score((int(mg_value(v)) * mg_value(w)) / 0x100,
335 (int(eg_value(v)) * eg_value(w)) / 0x100);
338 #undef ENABLE_OPERATORS_ON
339 #undef ENABLE_SAFE_OPERATORS_ON
343 extern Key psq[COLOR_NB][PIECE_TYPE_NB][SQUARE_NB];
344 extern Key enpassant[FILE_NB];
345 extern Key castle[CASTLE_RIGHT_NB];
347 extern Key exclusion;
354 extern Score pieceSquareTable[PIECE_NB][SQUARE_NB];
355 extern Value PieceValue[PHASE_NB][PIECE_NB];
356 extern int SquareDistance[SQUARE_NB][SQUARE_NB];
363 inline bool operator<(const MoveStack& f, const MoveStack& s) {
364 return f.score < s.score;
367 inline Color operator~(Color c) {
371 inline Square operator~(Square s) {
372 return Square(s ^ 56); // Vertical flip SQ_A1 -> SQ_A8
375 inline Square operator|(File f, Rank r) {
376 return Square((r << 3) | f);
379 inline Value mate_in(int ply) {
380 return VALUE_MATE - ply;
383 inline Value mated_in(int ply) {
384 return -VALUE_MATE + ply;
387 inline Piece make_piece(Color c, PieceType pt) {
388 return Piece((c << 3) | pt);
391 inline CastleRight make_castle_right(Color c, CastlingSide s) {
392 return CastleRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
395 inline PieceType type_of(Piece p) {
396 return PieceType(p & 7);
399 inline Color color_of(Piece p) {
400 return p == NO_PIECE ? NO_COLOR : Color(p >> 3);
403 inline bool is_ok(Square s) {
404 return s >= SQ_A1 && s <= SQ_H8;
407 inline File file_of(Square s) {
411 inline Rank rank_of(Square s) {
415 inline Square mirror(Square s) {
416 return Square(s ^ 7); // Horizontal flip SQ_A1 -> SQ_H1
419 inline Square relative_square(Color c, Square s) {
420 return Square(s ^ (c * 56));
423 inline Rank relative_rank(Color c, Rank r) {
424 return Rank(r ^ (c * 7));
427 inline Rank relative_rank(Color c, Square s) {
428 return relative_rank(c, rank_of(s));
431 inline bool opposite_colors(Square s1, Square s2) {
432 int s = int(s1) ^ int(s2);
433 return ((s >> 3) ^ s) & 1;
436 inline int file_distance(Square s1, Square s2) {
437 return abs(file_of(s1) - file_of(s2));
440 inline int rank_distance(Square s1, Square s2) {
441 return abs(rank_of(s1) - rank_of(s2));
444 inline int square_distance(Square s1, Square s2) {
445 return SquareDistance[s1][s2];
448 inline char file_to_char(File f) {
449 return char(f - FILE_A + 'a');
452 inline char rank_to_char(Rank r) {
453 return char(r - RANK_1 + '1');
456 inline Square pawn_push(Color c) {
457 return c == WHITE ? DELTA_N : DELTA_S;
460 inline Square from_sq(Move m) {
461 return Square((m >> 6) & 0x3F);
464 inline Square to_sq(Move m) {
465 return Square(m & 0x3F);
468 inline MoveType type_of(Move m) {
469 return MoveType(m & (3 << 14));
472 inline PieceType promotion_type(Move m) {
473 return PieceType(((m >> 12) & 3) + 2);
476 inline Move make_move(Square from, Square to) {
477 return Move(to | (from << 6));
481 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
482 return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12)) ;
485 inline bool is_ok(Move m) {
486 return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
491 inline const std::string square_to_string(Square s) {
492 char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
496 /// Our insertion sort implementation, works with pointers and iterators and is
497 /// guaranteed to be stable, as is needed.
498 template<typename T, typename K>
499 void sort(K begin, K end)
504 for (p = begin + 1; p < end; p++)
507 for (q = p; q != begin && *(q-1) < tmp; --q)
513 #endif // !defined(TYPES_H_INCLUDED)