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