Introduce bad outpost penalty
[stockfish] / src / bitboard.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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2020 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef BITBOARD_H_INCLUDED
22 #define BITBOARD_H_INCLUDED
23
24 #include <string>
25
26 #include "types.h"
27
28 namespace Bitbases {
29
30 void init();
31 bool probe(Square wksq, Square wpsq, Square bksq, Color us);
32
33 }
34
35 namespace Bitboards {
36
37 void init();
38 const std::string pretty(Bitboard b);
39
40 }
41
42 constexpr Bitboard AllSquares = ~Bitboard(0);
43 constexpr Bitboard DarkSquares = 0xAA55AA55AA55AA55ULL;
44
45 constexpr Bitboard FileABB = 0x0101010101010101ULL;
46 constexpr Bitboard FileBBB = FileABB << 1;
47 constexpr Bitboard FileCBB = FileABB << 2;
48 constexpr Bitboard FileDBB = FileABB << 3;
49 constexpr Bitboard FileEBB = FileABB << 4;
50 constexpr Bitboard FileFBB = FileABB << 5;
51 constexpr Bitboard FileGBB = FileABB << 6;
52 constexpr Bitboard FileHBB = FileABB << 7;
53
54 constexpr Bitboard Rank1BB = 0xFF;
55 constexpr Bitboard Rank2BB = Rank1BB << (8 * 1);
56 constexpr Bitboard Rank3BB = Rank1BB << (8 * 2);
57 constexpr Bitboard Rank4BB = Rank1BB << (8 * 3);
58 constexpr Bitboard Rank5BB = Rank1BB << (8 * 4);
59 constexpr Bitboard Rank6BB = Rank1BB << (8 * 5);
60 constexpr Bitboard Rank7BB = Rank1BB << (8 * 6);
61 constexpr Bitboard Rank8BB = Rank1BB << (8 * 7);
62
63 constexpr Bitboard QueenSide   = FileABB | FileBBB | FileCBB | FileDBB;
64 constexpr Bitboard CenterFiles = FileCBB | FileDBB | FileEBB | FileFBB;
65 constexpr Bitboard KingSide    = FileEBB | FileFBB | FileGBB | FileHBB;
66 constexpr Bitboard Center      = (FileDBB | FileEBB) & (Rank4BB | Rank5BB);
67
68 constexpr Bitboard KingFlank[FILE_NB] = {
69   QueenSide ^ FileDBB, QueenSide, QueenSide,
70   CenterFiles, CenterFiles,
71   KingSide, KingSide, KingSide ^ FileEBB
72 };
73
74 extern uint8_t PopCnt16[1 << 16];
75 extern uint8_t SquareDistance[SQUARE_NB][SQUARE_NB];
76
77 extern Bitboard SquareBB[SQUARE_NB];
78 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
79 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
80 extern Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
81
82
83 /// Magic holds all magic bitboards relevant data for a single square
84 struct Magic {
85   Bitboard  mask;
86   Bitboard  magic;
87   Bitboard* attacks;
88   unsigned  shift;
89
90   // Compute the attack's index using the 'magic bitboards' approach
91   unsigned index(Bitboard occupied) const {
92
93     if (HasPext)
94         return unsigned(pext(occupied, mask));
95
96     if (Is64Bit)
97         return unsigned(((occupied & mask) * magic) >> shift);
98
99     unsigned lo = unsigned(occupied) & unsigned(mask);
100     unsigned hi = unsigned(occupied >> 32) & unsigned(mask >> 32);
101     return (lo * unsigned(magic) ^ hi * unsigned(magic >> 32)) >> shift;
102   }
103 };
104
105 extern Magic RookMagics[SQUARE_NB];
106 extern Magic BishopMagics[SQUARE_NB];
107
108 inline Bitboard square_bb(Square s) {
109   assert(is_ok(s));
110   return SquareBB[s];
111 }
112
113
114 /// Overloads of bitwise operators between a Bitboard and a Square for testing
115 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
116
117 inline Bitboard  operator&( Bitboard  b, Square s) { return b &  square_bb(s); }
118 inline Bitboard  operator|( Bitboard  b, Square s) { return b |  square_bb(s); }
119 inline Bitboard  operator^( Bitboard  b, Square s) { return b ^  square_bb(s); }
120 inline Bitboard& operator|=(Bitboard& b, Square s) { return b |= square_bb(s); }
121 inline Bitboard& operator^=(Bitboard& b, Square s) { return b ^= square_bb(s); }
122
123 inline Bitboard  operator&(Square s, Bitboard b) { return b & s; }
124 inline Bitboard  operator|(Square s, Bitboard b) { return b | s; }
125 inline Bitboard  operator^(Square s, Bitboard b) { return b ^ s; }
126
127 inline Bitboard  operator|(Square s1, Square s2) { return square_bb(s1) | s2; }
128
129 constexpr bool more_than_one(Bitboard b) {
130   return b & (b - 1);
131 }
132
133 /// Counts the occupation of the bitboard depending on the occupation of SQ_A1
134 /// as in `b & (1ULL << SQ_A1) ? more_than_two(b) : more_than_one(b)`
135
136 constexpr bool conditional_more_than_two(Bitboard b) {
137   return b & (b - 1) & (b - 2);
138 }
139
140 constexpr bool opposite_colors(Square s1, Square s2) {
141   return (s1 + rank_of(s1) + s2 + rank_of(s2)) & 1;
142 }
143
144
145 /// rank_bb() and file_bb() return a bitboard representing all the squares on
146 /// the given file or rank.
147
148 constexpr Bitboard rank_bb(Rank r) {
149   return Rank1BB << (8 * r);
150 }
151
152 constexpr Bitboard rank_bb(Square s) {
153   return rank_bb(rank_of(s));
154 }
155
156 constexpr Bitboard file_bb(File f) {
157   return FileABB << f;
158 }
159
160 constexpr Bitboard file_bb(Square s) {
161   return file_bb(file_of(s));
162 }
163
164
165 /// shift() moves a bitboard one or two steps as specified by the direction D
166
167 template<Direction D>
168 constexpr Bitboard shift(Bitboard b) {
169   return  D == NORTH      ?  b             << 8 : D == SOUTH      ?  b             >> 8
170         : D == NORTH+NORTH?  b             <<16 : D == SOUTH+SOUTH?  b             >>16
171         : D == EAST       ? (b & ~FileHBB) << 1 : D == WEST       ? (b & ~FileABB) >> 1
172         : D == NORTH_EAST ? (b & ~FileHBB) << 9 : D == NORTH_WEST ? (b & ~FileABB) << 7
173         : D == SOUTH_EAST ? (b & ~FileHBB) >> 7 : D == SOUTH_WEST ? (b & ~FileABB) >> 9
174         : 0;
175 }
176
177
178 /// pawn_attacks_bb() returns the squares attacked by pawns of the given color
179 /// from the squares in the given bitboard.
180
181 template<Color C>
182 constexpr Bitboard pawn_attacks_bb(Bitboard b) {
183   return C == WHITE ? shift<NORTH_WEST>(b) | shift<NORTH_EAST>(b)
184                     : shift<SOUTH_WEST>(b) | shift<SOUTH_EAST>(b);
185 }
186
187 inline Bitboard pawn_attacks_bb(Color c, Square s) {
188
189   assert(is_ok(s));
190   return PawnAttacks[c][s];
191 }
192
193
194 /// pawn_double_attacks_bb() returns the squares doubly attacked by pawns of the
195 /// given color from the squares in the given bitboard.
196
197 template<Color C>
198 constexpr Bitboard pawn_double_attacks_bb(Bitboard b) {
199   return C == WHITE ? shift<NORTH_WEST>(b) & shift<NORTH_EAST>(b)
200                     : shift<SOUTH_WEST>(b) & shift<SOUTH_EAST>(b);
201 }
202
203
204 /// adjacent_files_bb() returns a bitboard representing all the squares on the
205 /// adjacent files of a given square.
206
207 constexpr Bitboard adjacent_files_bb(Square s) {
208   return shift<EAST>(file_bb(s)) | shift<WEST>(file_bb(s));
209 }
210
211
212 /// line_bb() returns a bitboard representing an entire line (from board edge
213 /// to board edge) that intersects the two given squares. If the given squares
214 /// are not on a same file/rank/diagonal, the function returns 0. For instance,
215 /// line_bb(SQ_C4, SQ_F7) will return a bitboard with the A2-G8 diagonal.
216
217 inline Bitboard line_bb(Square s1, Square s2) {
218
219   assert(is_ok(s1) && is_ok(s2));
220   return LineBB[s1][s2];
221 }
222
223
224 /// between_bb() returns a bitboard representing squares that are linearly
225 /// between the two given squares (excluding the given squares). If the given
226 /// squares are not on a same file/rank/diagonal, we return 0. For instance,
227 /// between_bb(SQ_C4, SQ_F7) will return a bitboard with squares D5 and E6.
228
229 inline Bitboard between_bb(Square s1, Square s2) {
230   Bitboard b = line_bb(s1, s2) & ((AllSquares << s1) ^ (AllSquares << s2));
231   return b & (b - 1); //exclude lsb
232 }
233
234
235 /// forward_ranks_bb() returns a bitboard representing the squares on the ranks
236 /// in front of the given one, from the point of view of the given color. For instance,
237 /// forward_ranks_bb(BLACK, SQ_D3) will return the 16 squares on ranks 1 and 2.
238
239 constexpr Bitboard forward_ranks_bb(Color c, Square s) {
240   return c == WHITE ? ~Rank1BB << 8 * relative_rank(WHITE, s)
241                     : ~Rank8BB >> 8 * relative_rank(BLACK, s);
242 }
243
244
245 /// forward_file_bb() returns a bitboard representing all the squares along the
246 /// line in front of the given one, from the point of view of the given color.
247
248 constexpr Bitboard forward_file_bb(Color c, Square s) {
249   return forward_ranks_bb(c, s) & file_bb(s);
250 }
251
252
253 /// pawn_attack_span() returns a bitboard representing all the squares that can
254 /// be attacked by a pawn of the given color when it moves along its file, starting
255 /// from the given square.
256
257 constexpr Bitboard pawn_attack_span(Color c, Square s) {
258   return forward_ranks_bb(c, s) & adjacent_files_bb(s);
259 }
260
261
262 /// passed_pawn_span() returns a bitboard which can be used to test if a pawn of
263 /// the given color and on the given square is a passed pawn.
264
265 constexpr Bitboard passed_pawn_span(Color c, Square s) {
266   return pawn_attack_span(c, s) | forward_file_bb(c, s);
267 }
268
269
270 /// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
271 /// straight or on a diagonal line.
272
273 inline bool aligned(Square s1, Square s2, Square s3) {
274   return line_bb(s1, s2) & s3;
275 }
276
277
278 /// distance() functions return the distance between x and y, defined as the
279 /// number of steps for a king in x to reach y.
280
281 template<typename T1 = Square> inline int distance(Square x, Square y);
282 template<> inline int distance<File>(Square x, Square y) { return std::abs(file_of(x) - file_of(y)); }
283 template<> inline int distance<Rank>(Square x, Square y) { return std::abs(rank_of(x) - rank_of(y)); }
284 template<> inline int distance<Square>(Square x, Square y) { return SquareDistance[x][y]; }
285
286 inline int edge_distance(File f) { return std::min(f, File(FILE_H - f)); }
287 inline int edge_distance(Rank r) { return std::min(r, Rank(RANK_8 - r)); }
288
289
290 /// safe_destination() returns the bitboard of target square for the given step
291 /// from the given square. If the step is off the board, returns empty bitboard.
292
293 inline Bitboard safe_destination(Square s, int step)
294 {
295     Square to = Square(s + step);
296     return is_ok(to) && distance(s, to) <= 2 ? square_bb(to) : Bitboard(0);
297 }
298
299
300 /// attacks_bb(Square) returns the pseudo attacks of the give piece type
301 /// assuming an empty board.
302
303 template<PieceType Pt>
304 inline Bitboard attacks_bb(Square s) {
305
306   assert((Pt != PAWN) && (is_ok(s)));
307
308   return PseudoAttacks[Pt][s];
309 }
310
311
312 /// attacks_bb(Square, Bitboard) returns the attacks by the given piece
313 /// assuming the board is occupied according to the passed Bitboard.
314 /// Sliding piece attacks do not continue passed an occupied square.
315
316 template<PieceType Pt>
317 inline Bitboard attacks_bb(Square s, Bitboard occupied) {
318
319   assert((Pt != PAWN) && (is_ok(s)));
320
321   switch (Pt)
322   {
323   case BISHOP: return BishopMagics[s].attacks[BishopMagics[s].index(occupied)];
324   case ROOK  : return   RookMagics[s].attacks[  RookMagics[s].index(occupied)];
325   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
326   default    : return PseudoAttacks[Pt][s];
327   }
328 }
329
330 inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
331
332   assert((pt != PAWN) && (is_ok(s)));
333
334   switch (pt)
335   {
336   case BISHOP: return attacks_bb<BISHOP>(s, occupied);
337   case ROOK  : return attacks_bb<  ROOK>(s, occupied);
338   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
339   default    : return PseudoAttacks[pt][s];
340   }
341 }
342
343
344 /// popcount() counts the number of non-zero bits in a bitboard
345
346 inline int popcount(Bitboard b) {
347
348 #ifndef USE_POPCNT
349
350   union { Bitboard bb; uint16_t u[4]; } v = { b };
351   return PopCnt16[v.u[0]] + PopCnt16[v.u[1]] + PopCnt16[v.u[2]] + PopCnt16[v.u[3]];
352
353 #elif defined(_MSC_VER) || defined(__INTEL_COMPILER)
354
355   return (int)_mm_popcnt_u64(b);
356
357 #else // Assumed gcc or compatible compiler
358
359   return __builtin_popcountll(b);
360
361 #endif
362 }
363
364
365 /// lsb() and msb() return the least/most significant bit in a non-zero bitboard
366
367 #if defined(__GNUC__)  // GCC, Clang, ICC
368
369 inline Square lsb(Bitboard b) {
370   assert(b);
371   return Square(__builtin_ctzll(b));
372 }
373
374 inline Square msb(Bitboard b) {
375   assert(b);
376   return Square(63 ^ __builtin_clzll(b));
377 }
378
379 #elif defined(_MSC_VER)  // MSVC
380
381 #ifdef _WIN64  // MSVC, WIN64
382
383 inline Square lsb(Bitboard b) {
384   assert(b);
385   unsigned long idx;
386   _BitScanForward64(&idx, b);
387   return (Square) idx;
388 }
389
390 inline Square msb(Bitboard b) {
391   assert(b);
392   unsigned long idx;
393   _BitScanReverse64(&idx, b);
394   return (Square) idx;
395 }
396
397 #else  // MSVC, WIN32
398
399 inline Square lsb(Bitboard b) {
400   assert(b);
401   unsigned long idx;
402
403   if (b & 0xffffffff) {
404       _BitScanForward(&idx, int32_t(b));
405       return Square(idx);
406   } else {
407       _BitScanForward(&idx, int32_t(b >> 32));
408       return Square(idx + 32);
409   }
410 }
411
412 inline Square msb(Bitboard b) {
413   assert(b);
414   unsigned long idx;
415
416   if (b >> 32) {
417       _BitScanReverse(&idx, int32_t(b >> 32));
418       return Square(idx + 32);
419   } else {
420       _BitScanReverse(&idx, int32_t(b));
421       return Square(idx);
422   }
423 }
424
425 #endif
426
427 #else  // Compiler is neither GCC nor MSVC compatible
428
429 #error "Compiler not supported."
430
431 #endif
432
433
434 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard
435
436 inline Square pop_lsb(Bitboard* b) {
437   assert(*b);
438   const Square s = lsb(*b);
439   *b &= *b - 1;
440   return s;
441 }
442
443
444 /// frontmost_sq() returns the most advanced square for the given color,
445 /// requires a non-zero bitboard.
446 inline Square frontmost_sq(Color c, Bitboard b) {
447   assert(b);
448   return c == WHITE ? msb(b) : lsb(b);
449 }
450
451 #endif // #ifndef BITBOARD_H_INCLUDED