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-2015 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 /// When compiling with provided Makefile (e.g. for Linux and OSX), configuration
24 /// is done automatically. To get started type 'make help'.
26 /// When Makefile is not used (e.g. with Microsoft Visual Studio) some switches
27 /// need to be set manually:
29 /// -DNDEBUG | Disable debugging mode. Always use this for release.
31 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. You may need this to
32 /// | 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 and requires hardware with popcnt support.
44 /// Predefined macros hell:
46 /// __GNUC__ Compiler is gcc, Clang or Intel on Linux
47 /// __INTEL_COMPILER Compiler is Intel
48 /// _MSC_VER Compiler is MSVC or Intel on Windows
49 /// _WIN32 Building on Windows (any)
50 /// _WIN64 Building on Windows 64 bit
52 #if defined(_WIN64) && !defined(IS_64BIT) // Last condition means Makefile is not used
53 # include <intrin.h> // MSVC popcnt and bsfq instrinsics
58 #if defined(USE_POPCNT) && defined(__INTEL_COMPILER) && defined(_MSC_VER)
59 # include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
62 #if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
63 # include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
67 # include <immintrin.h> // Header for _pext_u64() intrinsic
68 # define pext(b, m) _pext_u64(b, m)
70 # define pext(b, m) (0)
74 # define FORCE_INLINE __forceinline
75 #elif defined(__GNUC__)
76 # define FORCE_INLINE inline __attribute__((always_inline))
78 # define FORCE_INLINE inline
82 const bool HasPopCnt = true;
84 const bool HasPopCnt = false;
88 const bool HasPext = true;
90 const bool HasPext = false;
94 const bool Is64Bit = true;
96 const bool Is64Bit = false;
100 typedef uint64_t Bitboard;
102 const int MAX_MOVES = 256;
103 const int MAX_PLY = 128;
105 /// A move needs 16 bits to be stored
107 /// bit 0- 5: destination square (from 0 to 63)
108 /// bit 6-11: origin square (from 0 to 63)
109 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
110 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
111 /// NOTE: EN-PASSANT bit is set only when a pawn can be captured
113 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
114 /// any normal move destination square is always different from origin square
115 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
130 WHITE, BLACK, NO_COLOR, COLOR_NB = 2
134 KING_SIDE, QUEEN_SIDE, CASTLING_SIDE_NB = 2
140 WHITE_OOO = WHITE_OO << 1,
141 BLACK_OO = WHITE_OO << 2,
142 BLACK_OOO = WHITE_OO << 3,
143 ANY_CASTLING = WHITE_OO | WHITE_OOO | BLACK_OO | BLACK_OOO,
144 CASTLING_RIGHT_NB = 16
147 template<Color C, CastlingSide S> struct MakeCastling {
148 static const CastlingRight
149 right = C == WHITE ? S == QUEEN_SIDE ? WHITE_OOO : WHITE_OO
150 : S == QUEEN_SIDE ? BLACK_OOO : BLACK_OO;
156 MG = 0, EG = 1, PHASE_NB = 2
160 SCALE_FACTOR_DRAW = 0,
161 SCALE_FACTOR_ONEPAWN = 48,
162 SCALE_FACTOR_NORMAL = 64,
163 SCALE_FACTOR_MAX = 128,
164 SCALE_FACTOR_NONE = 255
171 BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
177 VALUE_KNOWN_WIN = 10000,
179 VALUE_INFINITE = 32001,
182 VALUE_MATE_IN_MAX_PLY = VALUE_MATE - 2 * MAX_PLY,
183 VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + 2 * MAX_PLY,
185 VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
186 VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN,
188 PawnValueMg = 198, PawnValueEg = 258,
189 KnightValueMg = 817, KnightValueEg = 846,
190 BishopValueMg = 836, BishopValueEg = 857,
191 RookValueMg = 1270, RookValueEg = 1278,
192 QueenValueMg = 2521, QueenValueEg = 2558,
194 MidgameLimit = 15581, EndgameLimit = 3998
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,
216 DEPTH_QS_NO_CHECKS = -1,
217 DEPTH_QS_RECAPTURES = -5,
224 SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
225 SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
226 SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
227 SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
228 SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
229 SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
230 SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
231 SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
241 DELTA_NN = DELTA_N + DELTA_N,
242 DELTA_NE = DELTA_N + DELTA_E,
243 DELTA_SE = DELTA_S + DELTA_E,
244 DELTA_SS = DELTA_S + DELTA_S,
245 DELTA_SW = DELTA_S + DELTA_W,
246 DELTA_NW = DELTA_N + DELTA_W
250 FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
254 RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
258 /// Score enum stores a middlegame and an endgame value in a single integer.
259 /// The least significant 16 bits are used to store the endgame value and
260 /// the upper 16 bits are used to store the middlegame value. The compiler
261 /// is free to choose the enum type as long as it can store the data, so we
262 /// ensure that Score is an integer type by assigning some big int values.
265 SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
266 SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
269 inline Score make_score(int mg, int eg) {
270 return Score((mg << 16) + eg);
273 /// Extracting the signed lower and upper 16 bits is not so trivial because
274 /// according to the standard a simple cast to short is implementation defined
275 /// and so is a right shift of a signed integer.
276 inline Value mg_value(Score s) {
278 union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s + 0x8000) >> 16) };
282 inline Value eg_value(Score s) {
284 union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s)) };
288 #define ENABLE_BASE_OPERATORS_ON(T) \
289 inline T operator+(T d1, T d2) { return T(int(d1) + int(d2)); } \
290 inline T operator-(T d1, T d2) { return T(int(d1) - int(d2)); } \
291 inline T operator*(int i, T d) { return T(i * int(d)); } \
292 inline T operator*(T d, int i) { return T(int(d) * i); } \
293 inline T operator-(T d) { return T(-int(d)); } \
294 inline T& operator+=(T& d1, T d2) { return d1 = d1 + d2; } \
295 inline T& operator-=(T& d1, T d2) { return d1 = d1 - d2; } \
296 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
298 #define ENABLE_FULL_OPERATORS_ON(T) \
299 ENABLE_BASE_OPERATORS_ON(T) \
300 inline T& operator++(T& d) { return d = T(int(d) + 1); } \
301 inline T& operator--(T& d) { return d = T(int(d) - 1); } \
302 inline T operator/(T d, int i) { return T(int(d) / i); } \
303 inline int operator/(T d1, T d2) { return int(d1) / int(d2); } \
304 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
306 ENABLE_FULL_OPERATORS_ON(Value)
307 ENABLE_FULL_OPERATORS_ON(PieceType)
308 ENABLE_FULL_OPERATORS_ON(Piece)
309 ENABLE_FULL_OPERATORS_ON(Color)
310 ENABLE_FULL_OPERATORS_ON(Depth)
311 ENABLE_FULL_OPERATORS_ON(Square)
312 ENABLE_FULL_OPERATORS_ON(File)
313 ENABLE_FULL_OPERATORS_ON(Rank)
315 ENABLE_BASE_OPERATORS_ON(Score)
317 #undef ENABLE_FULL_OPERATORS_ON
318 #undef ENABLE_BASE_OPERATORS_ON
320 /// Additional operators to add integers to a Value
321 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
322 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
323 inline Value& operator+=(Value& v, int i) { return v = v + i; }
324 inline Value& operator-=(Value& v, int i) { return v = v - i; }
326 /// Only declared but not defined. We don't want to multiply two scores due to
327 /// a very high risk of overflow. So user should explicitly convert to integer.
328 inline Score operator*(Score s1, Score s2);
330 /// Division of a Score must be handled separately for each term
331 inline Score operator/(Score s, int i) {
332 return make_score(mg_value(s) / i, eg_value(s) / i);
335 extern Value PieceValue[PHASE_NB][PIECE_NB];
337 inline Color operator~(Color c) {
338 return Color(c ^ BLACK);
341 inline Square operator~(Square s) {
342 return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
345 inline CastlingRight operator|(Color c, CastlingSide s) {
346 return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
349 inline Value mate_in(int ply) {
350 return VALUE_MATE - ply;
353 inline Value mated_in(int ply) {
354 return -VALUE_MATE + ply;
357 inline Square make_square(File f, Rank r) {
358 return Square((r << 3) | f);
361 inline Piece make_piece(Color c, PieceType pt) {
362 return Piece((c << 3) | pt);
365 inline PieceType type_of(Piece pc) {
366 return PieceType(pc & 7);
369 inline Color color_of(Piece pc) {
370 assert(pc != NO_PIECE);
371 return Color(pc >> 3);
374 inline bool is_ok(Square s) {
375 return s >= SQ_A1 && s <= SQ_H8;
378 inline File file_of(Square s) {
382 inline Rank rank_of(Square s) {
386 inline Square relative_square(Color c, Square s) {
387 return Square(s ^ (c * 56));
390 inline Rank relative_rank(Color c, Rank r) {
391 return Rank(r ^ (c * 7));
394 inline Rank relative_rank(Color c, Square s) {
395 return relative_rank(c, rank_of(s));
398 inline bool opposite_colors(Square s1, Square s2) {
399 int s = int(s1) ^ int(s2);
400 return ((s >> 3) ^ s) & 1;
403 inline Square pawn_push(Color c) {
404 return c == WHITE ? DELTA_N : DELTA_S;
407 inline Square from_sq(Move m) {
408 return Square((m >> 6) & 0x3F);
411 inline Square to_sq(Move m) {
412 return Square(m & 0x3F);
415 inline MoveType type_of(Move m) {
416 return MoveType(m & (3 << 14));
419 inline PieceType promotion_type(Move m) {
420 return PieceType(((m >> 12) & 3) + 2);
423 inline Move make_move(Square from, Square to) {
424 return Move(to | (from << 6));
428 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
429 return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
432 inline bool is_ok(Move m) {
433 return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
436 #endif // #ifndef TYPES_H_INCLUDED