Additional renaming from DON
[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        = 100;
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 CastlingFlag {  // Defined as in PolyGlot book hash key
120   NO_CASTLING,
121   WHITE_OO,
122   WHITE_OOO   = WHITE_OO << 1,
123   BLACK_OO    = WHITE_OO << 2,
124   BLACK_OOO   = WHITE_OO << 3,
125   ANY_CASTLING = WHITE_OO | WHITE_OOO | BLACK_OO | BLACK_OOO,
126   CASTLING_FLAG_NB = 16
127 };
128
129 enum CastlingSide {
130   KING_SIDE,
131   QUEEN_SIDE,
132   CASTLING_SIDE_NB = 2
133 };
134
135 enum Phase {
136   PHASE_ENDGAME,
137   PHASE_MIDGAME = 128,
138   MG = 0, EG = 1, PHASE_NB = 2
139 };
140
141 enum ScaleFactor {
142   SCALE_FACTOR_DRAW    = 0,
143   SCALE_FACTOR_ONEPAWN = 48,
144   SCALE_FACTOR_NORMAL  = 64,
145   SCALE_FACTOR_MAX     = 128,
146   SCALE_FACTOR_NONE    = 255
147 };
148
149 enum Bound {
150   BOUND_NONE,
151   BOUND_UPPER,
152   BOUND_LOWER,
153   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
154 };
155
156 enum Value {
157   VALUE_ZERO      = 0,
158   VALUE_DRAW      = 0,
159   VALUE_KNOWN_WIN = 10000,
160   VALUE_MATE      = 30000,
161   VALUE_INFINITE  = 30001,
162   VALUE_NONE      = 30002,
163
164   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
165   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
166
167   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
168   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN,
169
170   PawnValueMg   = 198,   PawnValueEg   = 258,
171   KnightValueMg = 817,   KnightValueEg = 846,
172   BishopValueMg = 836,   BishopValueEg = 857,
173   RookValueMg   = 1270,  RookValueEg   = 1278,
174   QueenValueMg  = 2521,  QueenValueEg  = 2558
175 };
176
177 enum PieceType {
178   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
179   ALL_PIECES = 0,
180   PIECE_TYPE_NB = 8
181 };
182
183 enum Piece {
184   NO_PIECE,
185   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
186   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
187   PIECE_NB = 16
188 };
189
190 enum Color {
191   WHITE, BLACK, NO_COLOR, COLOR_NB = 2
192 };
193
194 enum Depth {
195
196   ONE_PLY = 2,
197
198   DEPTH_ZERO          =  0 * ONE_PLY,
199   DEPTH_QS_CHECKS     =  0 * ONE_PLY,
200   DEPTH_QS_NO_CHECKS  = -1 * ONE_PLY,
201   DEPTH_QS_RECAPTURES = -5 * ONE_PLY,
202
203   DEPTH_NONE = -127 * ONE_PLY
204 };
205
206 enum Square {
207   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
208   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
209   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
210   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
211   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
212   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
213   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
214   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
215   SQ_NONE,
216
217   SQUARE_NB = 64,
218
219   DELTA_N =  8,
220   DELTA_E =  1,
221   DELTA_S = -8,
222   DELTA_W = -1,
223
224   DELTA_NN = DELTA_N + DELTA_N,
225   DELTA_NE = DELTA_N + DELTA_E,
226   DELTA_SE = DELTA_S + DELTA_E,
227   DELTA_SS = DELTA_S + DELTA_S,
228   DELTA_SW = DELTA_S + DELTA_W,
229   DELTA_NW = DELTA_N + DELTA_W
230 };
231
232 enum File {
233   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
234 };
235
236 enum Rank {
237   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
238 };
239
240
241 /// The Score enum stores a middlegame and an endgame value in a single integer
242 /// (enum). The least significant 16 bits are used to store the endgame value
243 /// and the upper 16 bits are used to store the middlegame value. The compiler
244 /// is free to choose the enum type as long as it can store the data, so we
245 /// ensure that Score is an integer type by assigning some big int values.
246 enum Score {
247   SCORE_ZERO,
248   SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
249   SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
250 };
251
252 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
253
254 /// Extracting the signed lower and upper 16 bits is not so trivial because
255 /// according to the standard a simple cast to short is implementation defined
256 /// and so is a right shift of a signed integer.
257 inline Value mg_value(Score s) { return Value(((s + 0x8000) & ~0xffff) / 0x10000); }
258
259 /// On Intel 64 bit we have a small speed regression with the standard conforming
260 /// version. Therefore, in this case we use faster code that, although not 100%
261 /// standard compliant, seems to work for Intel and MSVC.
262 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
263
264 inline Value eg_value(Score s) { return Value(int16_t(s & 0xFFFF)); }
265
266 #else
267
268 inline Value eg_value(Score s) {
269   return Value((int)(unsigned(s) & 0x7FFFU) - (int)(unsigned(s) & 0x8000U));
270 }
271
272 #endif
273
274 #define ENABLE_SAFE_OPERATORS_ON(T)                                         \
275 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
276 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
277 inline T operator*(int i, const T d) { return T(i * int(d)); }              \
278 inline T operator*(const T d, int i) { return T(int(d) * i); }              \
279 inline T operator-(const T d) { return T(-int(d)); }                        \
280 inline T& operator+=(T& d1, const T d2) { return d1 = d1 + d2; }            \
281 inline T& operator-=(T& d1, const T d2) { return d1 = d1 - d2; }            \
282 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
283
284 #define ENABLE_OPERATORS_ON(T) ENABLE_SAFE_OPERATORS_ON(T)                  \
285 inline T& operator++(T& d) { return d = T(int(d) + 1); }                    \
286 inline T& operator--(T& d) { return d = T(int(d) - 1); }                    \
287 inline T operator/(const T d, int i) { return T(int(d) / i); }              \
288 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
289
290 ENABLE_OPERATORS_ON(Value)
291 ENABLE_OPERATORS_ON(PieceType)
292 ENABLE_OPERATORS_ON(Piece)
293 ENABLE_OPERATORS_ON(Color)
294 ENABLE_OPERATORS_ON(Depth)
295 ENABLE_OPERATORS_ON(Square)
296 ENABLE_OPERATORS_ON(File)
297 ENABLE_OPERATORS_ON(Rank)
298
299 /// Additional operators to add integers to a Value
300 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
301 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
302
303 ENABLE_SAFE_OPERATORS_ON(Score)
304
305 /// Only declared but not defined. We don't want to multiply two scores due to
306 /// a very high risk of overflow. So user should explicitly convert to integer.
307 inline Score operator*(Score s1, Score s2);
308
309 /// Division of a Score must be handled separately for each term
310 inline Score operator/(Score s, int i) {
311   return make_score(mg_value(s) / i, eg_value(s) / i);
312 }
313
314 #undef ENABLE_OPERATORS_ON
315 #undef ENABLE_SAFE_OPERATORS_ON
316
317 extern Value PieceValue[PHASE_NB][PIECE_NB];
318
319 struct ExtMove {
320   Move move;
321   int score;
322 };
323
324 inline bool operator<(const ExtMove& f, const ExtMove& s) {
325   return f.score < s.score;
326 }
327
328 inline Color operator~(Color c) {
329   return Color(c ^ BLACK);
330 }
331
332 inline Square operator~(Square s) {
333   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
334 }
335
336 inline Square operator|(File f, Rank r) {
337   return Square((r << 3) | f);
338 }
339
340 inline Value mate_in(int ply) {
341   return VALUE_MATE - ply;
342 }
343
344 inline Value mated_in(int ply) {
345   return -VALUE_MATE + ply;
346 }
347
348 inline Piece make_piece(Color c, PieceType pt) {
349   return Piece((c << 3) | pt);
350 }
351
352 inline CastlingFlag make_castling_flag(Color c, CastlingSide s) {
353   return CastlingFlag(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
354 }
355
356 inline PieceType type_of(Piece p)  {
357   return PieceType(p & 7);
358 }
359
360 inline Color color_of(Piece p) {
361   assert(p != NO_PIECE);
362   return Color(p >> 3);
363 }
364
365 inline bool is_ok(Square s) {
366   return s >= SQ_A1 && s <= SQ_H8;
367 }
368
369 inline File file_of(Square s) {
370   return File(s & 7);
371 }
372
373 inline Rank rank_of(Square s) {
374   return Rank(s >> 3);
375 }
376
377 inline Square relative_square(Color c, Square s) {
378   return Square(s ^ (c * 56));
379 }
380
381 inline Rank relative_rank(Color c, Rank r) {
382   return Rank(r ^ (c * 7));
383 }
384
385 inline Rank relative_rank(Color c, Square s) {
386   return relative_rank(c, rank_of(s));
387 }
388
389 inline bool opposite_colors(Square s1, Square s2) {
390   int s = int(s1) ^ int(s2);
391   return ((s >> 3) ^ s) & 1;
392 }
393
394 inline char file_to_char(File f, bool tolower = true) {
395   return char(f - FILE_A + (tolower ? 'a' : 'A'));
396 }
397
398 inline char rank_to_char(Rank r) {
399   return char(r - RANK_1 + '1');
400 }
401
402 inline Square pawn_push(Color c) {
403   return c == WHITE ? DELTA_N : DELTA_S;
404 }
405
406 inline Square from_sq(Move m) {
407   return Square((m >> 6) & 0x3F);
408 }
409
410 inline Square to_sq(Move m) {
411   return Square(m & 0x3F);
412 }
413
414 inline MoveType type_of(Move m) {
415   return MoveType(m & (3 << 14));
416 }
417
418 inline PieceType promotion_type(Move m) {
419   return PieceType(((m >> 12) & 3) + 2);
420 }
421
422 inline Move make_move(Square from, Square to) {
423   return Move(to | (from << 6));
424 }
425
426 template<MoveType T>
427 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
428   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
429 }
430
431 inline bool is_ok(Move m) {
432   return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
433 }
434
435 #include <string>
436
437 inline const std::string square_to_string(Square s) {
438   char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
439   return ch;
440 }
441
442 #endif // #ifndef TYPES_H_INCLUDED