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