Rename score to value in ExtMove
[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-2014 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 #ifndef 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. Always use this.
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 <cassert>
39 #include <cctype>
40 #include <climits>
41 #include <cstdlib>
42
43 #include "platform.h"
44
45 #define unlikely(x) (x) // For code annotation purposes
46
47 #if defined(_WIN64) && !defined(IS_64BIT)
48 #  include <intrin.h> // MSVC popcnt and bsfq instrinsics
49 #  define IS_64BIT
50 #  define USE_BSFQ
51 #endif
52
53 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
54 #  include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
55 #endif
56
57 #  if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
58 #   include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
59 #  endif
60
61 #define CACHE_LINE_SIZE 64
62 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
63 #  define CACHE_LINE_ALIGNMENT __declspec(align(CACHE_LINE_SIZE))
64 #else
65 #  define CACHE_LINE_ALIGNMENT  __attribute__ ((aligned(CACHE_LINE_SIZE)))
66 #endif
67
68 #ifdef _MSC_VER
69 #  define FORCE_INLINE  __forceinline
70 #elif defined(__GNUC__)
71 #  define FORCE_INLINE  inline __attribute__((always_inline))
72 #else
73 #  define FORCE_INLINE  inline
74 #endif
75
76 #ifdef USE_POPCNT
77 const bool HasPopCnt = true;
78 #else
79 const bool HasPopCnt = false;
80 #endif
81
82 #ifdef IS_64BIT
83 const bool Is64Bit = true;
84 #else
85 const bool Is64Bit = false;
86 #endif
87
88 typedef uint64_t Key;
89 typedef uint64_t Bitboard;
90
91 const int MAX_MOVES      = 256;
92 const int MAX_PLY        = 120;
93 const int MAX_PLY_PLUS_6 = MAX_PLY + 6;
94
95 /// A move needs 16 bits to be stored
96 ///
97 /// bit  0- 5: destination square (from 0 to 63)
98 /// bit  6-11: origin square (from 0 to 63)
99 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
100 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
101 /// NOTE: EN-PASSANT bit is set only when a pawn can be captured
102 ///
103 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
104 /// any normal move destination square is always different from origin square
105 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
106
107 enum Move {
108   MOVE_NONE,
109   MOVE_NULL = 65
110 };
111
112 enum MoveType {
113   NORMAL,
114   PROMOTION = 1 << 14,
115   ENPASSANT = 2 << 14,
116   CASTLING  = 3 << 14
117 };
118
119 enum Color {
120   WHITE, BLACK, NO_COLOR, COLOR_NB = 2
121 };
122
123 enum CastlingSide {
124   KING_SIDE, QUEEN_SIDE, CASTLING_SIDE_NB = 2
125 };
126
127 enum CastlingRight {  // Defined as in PolyGlot book hash key
128   NO_CASTLING,
129   WHITE_OO,
130   WHITE_OOO   = WHITE_OO << 1,
131   BLACK_OO    = WHITE_OO << 2,
132   BLACK_OOO   = WHITE_OO << 3,
133   ANY_CASTLING = WHITE_OO | WHITE_OOO | BLACK_OO | BLACK_OOO,
134   CASTLING_RIGHT_NB = 16
135 };
136
137 template<Color C, CastlingSide S> struct MakeCastling {
138   static const CastlingRight
139   right = C == WHITE ? S == QUEEN_SIDE ? WHITE_OOO : WHITE_OO
140                      : S == QUEEN_SIDE ? BLACK_OOO : BLACK_OO;
141 };
142
143 enum Phase {
144   PHASE_ENDGAME,
145   PHASE_MIDGAME = 128,
146   MG = 0, EG = 1, PHASE_NB = 2
147 };
148
149 enum ScaleFactor {
150   SCALE_FACTOR_DRAW    = 0,
151   SCALE_FACTOR_ONEPAWN = 48,
152   SCALE_FACTOR_NORMAL  = 64,
153   SCALE_FACTOR_MAX     = 128,
154   SCALE_FACTOR_NONE    = 255
155 };
156
157 enum Bound {
158   BOUND_NONE,
159   BOUND_UPPER,
160   BOUND_LOWER,
161   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
162 };
163
164 enum Value {
165   VALUE_ZERO      = 0,
166   VALUE_DRAW      = 0,
167   VALUE_KNOWN_WIN = 10000,
168   VALUE_MATE      = 30000,
169   VALUE_INFINITE  = 30001,
170   VALUE_NONE      = 30002,
171
172   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
173   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
174
175   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
176   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN,
177
178   PawnValueMg   = 198,   PawnValueEg   = 258,
179   KnightValueMg = 817,   KnightValueEg = 846,
180   BishopValueMg = 836,   BishopValueEg = 857,
181   RookValueMg   = 1270,  RookValueEg   = 1278,
182   QueenValueMg  = 2521,  QueenValueEg  = 2558
183 };
184
185 enum PieceType {
186   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
187   ALL_PIECES = 0,
188   PIECE_TYPE_NB = 8
189 };
190
191 enum Piece {
192   NO_PIECE,
193   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
194   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
195   PIECE_NB = 16
196 };
197
198 enum Depth {
199
200   ONE_PLY = 2,
201
202   DEPTH_ZERO          =  0 * ONE_PLY,
203   DEPTH_QS_CHECKS     =  0 * ONE_PLY,
204   DEPTH_QS_NO_CHECKS  = -1 * ONE_PLY,
205   DEPTH_QS_RECAPTURES = -5 * ONE_PLY,
206
207   DEPTH_NONE = -127 * ONE_PLY
208 };
209
210 enum Square {
211   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
212   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
213   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
214   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
215   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
216   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
217   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
218   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
219   SQ_NONE,
220
221   SQUARE_NB = 64,
222
223   DELTA_N =  8,
224   DELTA_E =  1,
225   DELTA_S = -8,
226   DELTA_W = -1,
227
228   DELTA_NN = DELTA_N + DELTA_N,
229   DELTA_NE = DELTA_N + DELTA_E,
230   DELTA_SE = DELTA_S + DELTA_E,
231   DELTA_SS = DELTA_S + DELTA_S,
232   DELTA_SW = DELTA_S + DELTA_W,
233   DELTA_NW = DELTA_N + DELTA_W
234 };
235
236 enum File {
237   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
238 };
239
240 enum Rank {
241   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
242 };
243
244
245 /// The Score enum stores a middlegame and an endgame value in a single integer
246 /// (enum). The least significant 16 bits are used to store the endgame value
247 /// and the upper 16 bits are used to store the middlegame value. The compiler
248 /// is free to choose the enum type as long as it can store the data, so we
249 /// ensure that Score is an integer type by assigning some big int values.
250 enum Score {
251   SCORE_ZERO,
252   SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
253   SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
254 };
255
256 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
257
258 /// Extracting the signed lower and upper 16 bits is not so trivial because
259 /// according to the standard a simple cast to short is implementation defined
260 /// and so is a right shift of a signed integer.
261 inline Value mg_value(Score s) { return Value(((s + 0x8000) & ~0xffff) / 0x10000); }
262
263 /// On Intel 64 bit we have a small speed regression with the standard conforming
264 /// version. Therefore, in this case we use faster code that, although not 100%
265 /// standard compliant, seems to work for Intel and MSVC.
266 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
267
268 inline Value eg_value(Score s) { return Value(int16_t(s & 0xFFFF)); }
269
270 #else
271
272 inline Value eg_value(Score s) {
273   return Value((int)(unsigned(s) & 0x7FFFU) - (int)(unsigned(s) & 0x8000U));
274 }
275
276 #endif
277
278 #define ENABLE_SAFE_OPERATORS_ON(T)                                         \
279 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
280 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
281 inline T operator*(int i, const T d) { return T(i * int(d)); }              \
282 inline T operator*(const T d, int i) { return T(int(d) * i); }              \
283 inline T operator-(const T d) { return T(-int(d)); }                        \
284 inline T& operator+=(T& d1, const T d2) { return d1 = d1 + d2; }            \
285 inline T& operator-=(T& d1, const T d2) { return d1 = d1 - d2; }            \
286 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
287
288 #define ENABLE_OPERATORS_ON(T) ENABLE_SAFE_OPERATORS_ON(T)                  \
289 inline T& operator++(T& d) { return d = T(int(d) + 1); }                    \
290 inline T& operator--(T& d) { return d = T(int(d) - 1); }                    \
291 inline T operator/(const T d, int i) { return T(int(d) / i); }              \
292 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
293
294 ENABLE_OPERATORS_ON(Value)
295 ENABLE_OPERATORS_ON(PieceType)
296 ENABLE_OPERATORS_ON(Piece)
297 ENABLE_OPERATORS_ON(Color)
298 ENABLE_OPERATORS_ON(Depth)
299 ENABLE_OPERATORS_ON(Square)
300 ENABLE_OPERATORS_ON(File)
301 ENABLE_OPERATORS_ON(Rank)
302
303 /// Additional operators to add integers to a Value
304 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
305 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
306
307 ENABLE_SAFE_OPERATORS_ON(Score)
308
309 /// Only declared but not defined. We don't want to multiply two scores due to
310 /// a very high risk of overflow. So user should explicitly convert to integer.
311 inline Score operator*(Score s1, Score s2);
312
313 /// Division of a Score must be handled separately for each term
314 inline Score operator/(Score s, int i) {
315   return make_score(mg_value(s) / i, eg_value(s) / i);
316 }
317
318 #undef ENABLE_OPERATORS_ON
319 #undef ENABLE_SAFE_OPERATORS_ON
320
321 extern Value PieceValue[PHASE_NB][PIECE_NB];
322
323 struct ExtMove {
324   Move move;
325   Value value;
326 };
327
328 inline bool operator<(const ExtMove& f, const ExtMove& s) {
329   return f.value < s.value;
330 }
331
332 inline Color operator~(Color c) {
333   return Color(c ^ BLACK);
334 }
335
336 inline Square operator~(Square s) {
337   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
338 }
339
340 inline CastlingRight operator|(Color c, CastlingSide s) {
341   return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
342 }
343
344 inline Value mate_in(int ply) {
345   return VALUE_MATE - ply;
346 }
347
348 inline Value mated_in(int ply) {
349   return -VALUE_MATE + ply;
350 }
351
352 inline Square make_square(File f, Rank r) {
353   return Square((r << 3) | f);
354 }
355
356 inline Piece make_piece(Color c, PieceType pt) {
357   return Piece((c << 3) | pt);
358 }
359
360 inline PieceType type_of(Piece p)  {
361   return PieceType(p & 7);
362 }
363
364 inline Color color_of(Piece p) {
365   assert(p != NO_PIECE);
366   return Color(p >> 3);
367 }
368
369 inline bool 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 relative_square(Color c, Square s) {
382   return Square(s ^ (c * 56));
383 }
384
385 inline Rank relative_rank(Color c, Rank r) {
386   return Rank(r ^ (c * 7));
387 }
388
389 inline Rank relative_rank(Color c, Square s) {
390   return relative_rank(c, rank_of(s));
391 }
392
393 inline bool opposite_colors(Square s1, Square s2) {
394   int s = int(s1) ^ int(s2);
395   return ((s >> 3) ^ s) & 1;
396 }
397
398 inline char to_char(File f, bool tolower = true) {
399   return char(f - FILE_A + (tolower ? 'a' : 'A'));
400 }
401
402 inline char to_char(Rank r) {
403   return char(r - RANK_1 + '1');
404 }
405
406 inline Square pawn_push(Color c) {
407   return c == WHITE ? DELTA_N : DELTA_S;
408 }
409
410 inline Square from_sq(Move m) {
411   return Square((m >> 6) & 0x3F);
412 }
413
414 inline Square to_sq(Move m) {
415   return Square(m & 0x3F);
416 }
417
418 inline MoveType type_of(Move m) {
419   return MoveType(m & (3 << 14));
420 }
421
422 inline PieceType promotion_type(Move m) {
423   return PieceType(((m >> 12) & 3) + 2);
424 }
425
426 inline Move make_move(Square from, Square to) {
427   return Move(to | (from << 6));
428 }
429
430 template<MoveType T>
431 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
432   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
433 }
434
435 inline bool is_ok(Move m) {
436   return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
437 }
438
439 #include <string>
440
441 inline const std::string to_string(Square s) {
442   char ch[] = { to_char(file_of(s)), to_char(rank_of(s)), 0 };
443   return ch;
444 }
445
446 #endif // #ifndef TYPES_H_INCLUDED