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