Use type_of() to categorize the moves
[stockfish] / src / types.h
1 /*
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
5
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.
10
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.
15
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/>.
18 */
19
20 #if !defined(TYPES_H_INCLUDED)
21 #define TYPES_H_INCLUDED
22
23 /// For Linux and OSX configuration is done automatically using Makefile. To get
24 /// started type 'make help'.
25 ///
26 /// For Windows, part of the configuration is detected automatically, but some
27 /// switches need to be set manually:
28 ///
29 /// -DNDEBUG      | Disable debugging mode. Use always.
30 ///
31 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. A must if you want
32 ///               | the executable to run on some very old machines.
33 ///
34 /// -DUSE_POPCNT  | Add runtime support for use of popcnt asm-instruction. Works
35 ///               | only in 64-bit mode. For compiling requires hardware with
36 ///               | popcnt support.
37
38 #include <cctype>
39 #include <climits>
40 #include <cstdlib>
41
42 #include "platform.h"
43
44 #if defined(_WIN64)
45 #  include <intrin.h> // MSVC popcnt and bsfq instrinsics
46 #  define IS_64BIT
47 #  define USE_BSFQ
48 #endif
49
50 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
51 #  include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
52 #endif
53
54 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
55 #  define CACHE_LINE_ALIGNMENT __declspec(align(64))
56 #else
57 #  define CACHE_LINE_ALIGNMENT  __attribute__ ((aligned(64)))
58 #endif
59
60 #if defined(_MSC_VER)
61 #  define FORCE_INLINE  __forceinline
62 #elif defined(__GNUC__)
63 #  define FORCE_INLINE  inline __attribute__((always_inline))
64 #else
65 #  define FORCE_INLINE  inline
66 #endif
67
68 #if defined(USE_POPCNT)
69 const bool HasPopCnt = true;
70 #else
71 const bool HasPopCnt = false;
72 #endif
73
74 #if defined(IS_64BIT)
75 const bool Is64Bit = true;
76 #else
77 const bool Is64Bit = false;
78 #endif
79
80 typedef uint64_t Key;
81 typedef uint64_t Bitboard;
82
83 const int MAX_MOVES      = 192;
84 const int MAX_PLY        = 100;
85 const int MAX_PLY_PLUS_2 = MAX_PLY + 2;
86
87 const Bitboard FileABB = 0x0101010101010101ULL;
88 const Bitboard FileBBB = FileABB << 1;
89 const Bitboard FileCBB = FileABB << 2;
90 const Bitboard FileDBB = FileABB << 3;
91 const Bitboard FileEBB = FileABB << 4;
92 const Bitboard FileFBB = FileABB << 5;
93 const Bitboard FileGBB = FileABB << 6;
94 const Bitboard FileHBB = FileABB << 7;
95
96 const Bitboard Rank1BB = 0xFF;
97 const Bitboard Rank2BB = Rank1BB << (8 * 1);
98 const Bitboard Rank3BB = Rank1BB << (8 * 2);
99 const Bitboard Rank4BB = Rank1BB << (8 * 3);
100 const Bitboard Rank5BB = Rank1BB << (8 * 4);
101 const Bitboard Rank6BB = Rank1BB << (8 * 5);
102 const Bitboard Rank7BB = Rank1BB << (8 * 6);
103 const Bitboard Rank8BB = Rank1BB << (8 * 7);
104
105
106 /// A move needs 16 bits to be stored
107 ///
108 /// bit  0- 5: destination square (from 0 to 63)
109 /// bit  6-11: origin square (from 0 to 63)
110 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
111 /// bit 14-15: special move flag: promotion (1), en passant (2), castle (3)
112 ///
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.
116
117 enum Move {
118   MOVE_NONE = 0,
119   MOVE_NULL = 65
120 };
121
122 enum MoveType {
123   NORMAL    = 0,
124   PROMOTION = 1 << 14,
125   ENPASSANT = 2 << 14,
126   CASTLE    = 3 << 14
127 };
128
129 enum CastleRight {  // Defined as in PolyGlot book hash key
130   CASTLES_NONE = 0,
131   WHITE_OO     = 1,
132   WHITE_OOO    = 2,
133   BLACK_OO     = 4,
134   BLACK_OOO    = 8,
135   ALL_CASTLES  = 15
136 };
137
138 enum CastlingSide {
139   KING_SIDE,
140   QUEEN_SIDE
141 };
142
143 enum ScaleFactor {
144   SCALE_FACTOR_DRAW   = 0,
145   SCALE_FACTOR_NORMAL = 64,
146   SCALE_FACTOR_MAX    = 128,
147   SCALE_FACTOR_NONE   = 255
148 };
149
150 enum Bound {
151   BOUND_NONE  = 0,
152   BOUND_UPPER = 1,
153   BOUND_LOWER = 2,
154   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
155 };
156
157 enum Value {
158   VALUE_ZERO      = 0,
159   VALUE_DRAW      = 0,
160   VALUE_KNOWN_WIN = 15000,
161   VALUE_MATE      = 30000,
162   VALUE_INFINITE  = 30001,
163   VALUE_NONE      = 30002,
164
165   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
166   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
167
168   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
169   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN
170 };
171
172 enum PieceType {
173   NO_PIECE_TYPE = 0, ALL_PIECES = 0,
174   PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6
175 };
176
177 enum Piece {
178   NO_PIECE = 16, // color_of(NO_PIECE) == NO_COLOR
179   W_PAWN = 1, W_KNIGHT =  2, W_BISHOP =  3, W_ROOK =  4, W_QUEEN =  5, W_KING =  6,
180   B_PAWN = 9, B_KNIGHT = 10, B_BISHOP = 11, B_ROOK = 12, B_QUEEN = 13, B_KING = 14
181 };
182
183 enum Color {
184   WHITE, BLACK, NO_COLOR
185 };
186
187 enum Depth {
188
189   ONE_PLY = 2,
190
191   DEPTH_ZERO          =  0 * ONE_PLY,
192   DEPTH_QS_CHECKS     = -1 * ONE_PLY,
193   DEPTH_QS_NO_CHECKS  = -2 * ONE_PLY,
194   DEPTH_QS_RECAPTURES = -5 * ONE_PLY,
195
196   DEPTH_NONE = -127 * ONE_PLY
197 };
198
199 enum Square {
200   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
201   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
202   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
203   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
204   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
205   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
206   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
207   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
208   SQ_NONE,
209
210   DELTA_N =  8,
211   DELTA_E =  1,
212   DELTA_S = -8,
213   DELTA_W = -1,
214
215   DELTA_NN = DELTA_N + DELTA_N,
216   DELTA_NE = DELTA_N + DELTA_E,
217   DELTA_SE = DELTA_S + DELTA_E,
218   DELTA_SS = DELTA_S + DELTA_S,
219   DELTA_SW = DELTA_S + DELTA_W,
220   DELTA_NW = DELTA_N + DELTA_W
221 };
222
223 enum File {
224   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H
225 };
226
227 enum Rank {
228   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8
229 };
230
231
232 /// Score enum keeps a midgame and an endgame value in a single integer (enum),
233 /// first LSB 16 bits are used to store endgame value, while upper bits are used
234 /// for midgame value. Compiler is free to choose the enum type as long as can
235 /// keep its data, so ensure Score to be an integer type.
236 enum Score {
237   SCORE_ZERO = 0,
238   SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
239   SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
240 };
241
242 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
243
244 /// Extracting the signed lower and upper 16 bits it not so trivial because
245 /// according to the standard a simple cast to short is implementation defined
246 /// and so is a right shift of a signed integer.
247 inline Value mg_value(Score s) { return Value(((s + 32768) & ~0xffff) / 0x10000); }
248
249 /// On Intel 64 bit we have a small speed regression with the standard conforming
250 /// version, so use a faster code in this case that, although not 100% standard
251 /// compliant it seems to work for Intel and MSVC.
252 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
253
254 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
255
256 #else
257
258 inline Value eg_value(Score s) {
259   return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u));
260 }
261
262 #endif
263
264 #define ENABLE_SAFE_OPERATORS_ON(T)                                         \
265 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
266 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
267 inline T operator*(int i, const T d) { return T(i * int(d)); }              \
268 inline T operator*(const T d, int i) { return T(int(d) * i); }              \
269 inline T operator-(const T d) { return T(-int(d)); }                        \
270 inline T& operator+=(T& d1, const T d2) { d1 = d1 + d2; return d1; }        \
271 inline T& operator-=(T& d1, const T d2) { d1 = d1 - d2; return d1; }        \
272 inline T& operator*=(T& d, int i) { d = T(int(d) * i); return d; }
273
274 #define ENABLE_OPERATORS_ON(T) ENABLE_SAFE_OPERATORS_ON(T)                  \
275 inline T operator++(T& d, int) { d = T(int(d) + 1); return d; }             \
276 inline T operator--(T& d, int) { d = T(int(d) - 1); return d; }             \
277 inline T operator/(const T d, int i) { return T(int(d) / i); }              \
278 inline T& operator/=(T& d, int i) { d = T(int(d) / i); return d; }
279
280 ENABLE_OPERATORS_ON(Value)
281 ENABLE_OPERATORS_ON(PieceType)
282 ENABLE_OPERATORS_ON(Piece)
283 ENABLE_OPERATORS_ON(Color)
284 ENABLE_OPERATORS_ON(Depth)
285 ENABLE_OPERATORS_ON(Square)
286 ENABLE_OPERATORS_ON(File)
287 ENABLE_OPERATORS_ON(Rank)
288
289 /// Added operators for adding integers to a Value
290 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
291 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
292
293 ENABLE_SAFE_OPERATORS_ON(Score)
294
295 /// Only declared but not defined. We don't want to multiply two scores due to
296 /// a very high risk of overflow. So user should explicitly convert to integer.
297 inline Score operator*(Score s1, Score s2);
298
299 /// Division of a Score must be handled separately for each term
300 inline Score operator/(Score s, int i) {
301   return make_score(mg_value(s) / i, eg_value(s) / i);
302 }
303
304 /// Weight score v by score w trying to prevent overflow
305 inline Score apply_weight(Score v, Score w) {
306   return make_score((int(mg_value(v)) * mg_value(w)) / 0x100,
307                     (int(eg_value(v)) * eg_value(w)) / 0x100);
308 }
309
310 #undef ENABLE_OPERATORS_ON
311 #undef ENABLE_SAFE_OPERATORS_ON
312
313 const Value PawnValueMidgame   = Value(198);
314 const Value PawnValueEndgame   = Value(258);
315 const Value KnightValueMidgame = Value(817);
316 const Value KnightValueEndgame = Value(846);
317 const Value BishopValueMidgame = Value(836);
318 const Value BishopValueEndgame = Value(857);
319 const Value RookValueMidgame   = Value(1270);
320 const Value RookValueEndgame   = Value(1278);
321 const Value QueenValueMidgame  = Value(2521);
322 const Value QueenValueEndgame  = Value(2558);
323
324 extern const Value PieceValueMidgame[17]; // Indexed by Piece or PieceType
325 extern const Value PieceValueEndgame[17];
326 extern int SquareDistance[64][64];
327
328 struct MoveStack {
329   Move move;
330   int score;
331 };
332
333 inline bool operator<(const MoveStack& f, const MoveStack& s) {
334   return f.score < s.score;
335 }
336
337 inline Color operator~(Color c) {
338   return Color(c ^ 1);
339 }
340
341 inline Square operator~(Square s) {
342   return Square(s ^ 56); // Vertical flip SQ_A1 -> SQ_A8
343 }
344
345 inline Square operator|(File f, Rank r) {
346   return Square((r << 3) | f);
347 }
348
349 inline Value mate_in(int ply) {
350   return VALUE_MATE - ply;
351 }
352
353 inline Value mated_in(int ply) {
354   return -VALUE_MATE + ply;
355 }
356
357 inline Piece make_piece(Color c, PieceType pt) {
358   return Piece((c << 3) | pt);
359 }
360
361 inline CastleRight make_castle_right(Color c, CastlingSide s) {
362   return CastleRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
363 }
364
365 inline PieceType type_of(Piece p)  {
366   return PieceType(p & 7);
367 }
368
369 inline Color color_of(Piece p) {
370   return Color(p >> 3);
371 }
372
373 inline bool is_ok(Square s) {
374   return s >= SQ_A1 && s <= SQ_H8;
375 }
376
377 inline File file_of(Square s) {
378   return File(s & 7);
379 }
380
381 inline Rank rank_of(Square s) {
382   return Rank(s >> 3);
383 }
384
385 inline Square mirror(Square s) {
386   return Square(s ^ 7); // Horizontal flip SQ_A1 -> SQ_H1
387 }
388
389 inline Square relative_square(Color c, Square s) {
390   return Square(s ^ (c * 56));
391 }
392
393 inline Rank relative_rank(Color c, Rank r) {
394   return Rank(r ^ (c * 7));
395 }
396
397 inline Rank relative_rank(Color c, Square s) {
398   return relative_rank(c, rank_of(s));
399 }
400
401 inline bool opposite_colors(Square s1, Square s2) {
402   int s = int(s1) ^ int(s2);
403   return ((s >> 3) ^ s) & 1;
404 }
405
406 inline int file_distance(Square s1, Square s2) {
407   return abs(file_of(s1) - file_of(s2));
408 }
409
410 inline int rank_distance(Square s1, Square s2) {
411   return abs(rank_of(s1) - rank_of(s2));
412 }
413
414 inline int square_distance(Square s1, Square s2) {
415   return SquareDistance[s1][s2];
416 }
417
418 inline char piece_type_to_char(PieceType pt) {
419   return " PNBRQK"[pt];
420 }
421
422 inline char file_to_char(File f) {
423   return char(f - FILE_A + int('a'));
424 }
425
426 inline char rank_to_char(Rank r) {
427   return char(r - RANK_1 + int('1'));
428 }
429
430 inline Square pawn_push(Color c) {
431   return c == WHITE ? DELTA_N : DELTA_S;
432 }
433
434 inline Square from_sq(Move m) {
435   return Square((m >> 6) & 0x3F);
436 }
437
438 inline Square to_sq(Move m) {
439   return Square(m & 0x3F);
440 }
441
442 inline MoveType type_of(Move m) {
443   return MoveType(m & (3 << 14));
444 }
445
446 inline PieceType promotion_type(Move m) {
447   return PieceType(((m >> 12) & 3) + 2);
448 }
449
450 inline Move make_move(Square from, Square to) {
451   return Move(to | (from << 6));
452 }
453
454 inline Move make_promotion(Square from, Square to, PieceType pt) {
455   return Move(to | (from << 6) | (1 << 14) | ((pt - 2) << 12)) ;
456 }
457
458 inline Move make_enpassant(Square from, Square to) {
459   return Move(to | (from << 6) | (2 << 14));
460 }
461
462 inline Move make_castle(Square from, Square to) {
463   return Move(to | (from << 6) | (3 << 14));
464 }
465
466 inline bool is_ok(Move m) {
467   return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
468 }
469
470 #include <string>
471
472 inline const std::string square_to_string(Square s) {
473   char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
474   return ch;
475 }
476
477 /// Our insertion sort implementation, works with pointers and iterators and is
478 /// guaranteed to be stable, as is needed.
479 template<typename T, typename K>
480 void sort(K first, K last)
481 {
482   T tmp;
483   K p, q;
484
485   for (p = first + 1; p < last; p++)
486   {
487       tmp = *p;
488       for (q = p; q != first && *(q-1) < tmp; --q)
489           *q = *(q-1);
490       *q = tmp;
491   }
492 }
493
494 #endif // !defined(TYPES_H_INCLUDED)