]> git.sesse.net Git - stockfish/blob - src/bitboard.h
244dc034c33d680611e861b469124a8b2e96d3cf
[stockfish] / src / bitboard.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
4
5   Stockfish is free software: you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9
10   Stockfish is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU General Public License for more details.
14
15   You should have received a copy of the GNU General Public License
16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 #ifndef BITBOARD_H_INCLUDED
20 #define BITBOARD_H_INCLUDED
21
22 #include <string>
23
24 #include "types.h"
25
26 namespace Stockfish {
27
28 namespace Bitboards {
29
30 void init();
31 std::string pretty(Bitboard b);
32
33 } // namespace Stockfish::Bitboards
34
35 constexpr Bitboard FileABB = 0x0101010101010101ULL;
36 constexpr Bitboard FileBBB = FileABB << 1;
37 constexpr Bitboard FileCBB = FileABB << 2;
38 constexpr Bitboard FileDBB = FileABB << 3;
39 constexpr Bitboard FileEBB = FileABB << 4;
40 constexpr Bitboard FileFBB = FileABB << 5;
41 constexpr Bitboard FileGBB = FileABB << 6;
42 constexpr Bitboard FileHBB = FileABB << 7;
43
44 constexpr Bitboard Rank1BB = 0xFF;
45 constexpr Bitboard Rank2BB = Rank1BB << (8 * 1);
46 constexpr Bitboard Rank3BB = Rank1BB << (8 * 2);
47 constexpr Bitboard Rank4BB = Rank1BB << (8 * 3);
48 constexpr Bitboard Rank5BB = Rank1BB << (8 * 4);
49 constexpr Bitboard Rank6BB = Rank1BB << (8 * 5);
50 constexpr Bitboard Rank7BB = Rank1BB << (8 * 6);
51 constexpr Bitboard Rank8BB = Rank1BB << (8 * 7);
52
53 extern uint8_t PopCnt16[1 << 16];
54 extern uint8_t SquareDistance[SQUARE_NB][SQUARE_NB];
55
56 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
57 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
58 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
59 extern Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
60
61
62 /// Magic holds all magic bitboards relevant data for a single square
63 struct Magic {
64   Bitboard  mask;
65   Bitboard  magic;
66   Bitboard* attacks;
67   unsigned  shift;
68
69   // Compute the attack's index using the 'magic bitboards' approach
70   unsigned index(Bitboard occupied) const {
71
72     if (HasPext)
73         return unsigned(pext(occupied, mask));
74
75     if (Is64Bit)
76         return unsigned(((occupied & mask) * magic) >> shift);
77
78     unsigned lo = unsigned(occupied) & unsigned(mask);
79     unsigned hi = unsigned(occupied >> 32) & unsigned(mask >> 32);
80     return (lo * unsigned(magic) ^ hi * unsigned(magic >> 32)) >> shift;
81   }
82 };
83
84 extern Magic RookMagics[SQUARE_NB];
85 extern Magic BishopMagics[SQUARE_NB];
86
87 inline Bitboard square_bb(Square s) {
88   assert(is_ok(s));
89   return (1ULL << s);
90 }
91
92
93 /// Overloads of bitwise operators between a Bitboard and a Square for testing
94 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
95
96 inline Bitboard  operator&( Bitboard  b, Square s) { return b &  square_bb(s); }
97 inline Bitboard  operator|( Bitboard  b, Square s) { return b |  square_bb(s); }
98 inline Bitboard  operator^( Bitboard  b, Square s) { return b ^  square_bb(s); }
99 inline Bitboard& operator|=(Bitboard& b, Square s) { return b |= square_bb(s); }
100 inline Bitboard& operator^=(Bitboard& b, Square s) { return b ^= square_bb(s); }
101
102 inline Bitboard  operator&(Square s, Bitboard b) { return b & s; }
103 inline Bitboard  operator|(Square s, Bitboard b) { return b | s; }
104 inline Bitboard  operator^(Square s, Bitboard b) { return b ^ s; }
105
106 inline Bitboard  operator|(Square s1, Square s2) { return square_bb(s1) | s2; }
107
108 constexpr bool more_than_one(Bitboard b) {
109   return b & (b - 1);
110 }
111
112
113 /// rank_bb() and file_bb() return a bitboard representing all the squares on
114 /// the given file or rank.
115
116 constexpr Bitboard rank_bb(Rank r) {
117   return Rank1BB << (8 * r);
118 }
119
120 constexpr Bitboard rank_bb(Square s) {
121   return rank_bb(rank_of(s));
122 }
123
124 constexpr Bitboard file_bb(File f) {
125   return FileABB << f;
126 }
127
128 constexpr Bitboard file_bb(Square s) {
129   return file_bb(file_of(s));
130 }
131
132
133 /// shift() moves a bitboard one or two steps as specified by the direction D
134
135 template<Direction D>
136 constexpr Bitboard shift(Bitboard b) {
137   return  D == NORTH      ?  b             << 8 : D == SOUTH      ?  b             >> 8
138         : D == NORTH+NORTH?  b             <<16 : D == SOUTH+SOUTH?  b             >>16
139         : D == EAST       ? (b & ~FileHBB) << 1 : D == WEST       ? (b & ~FileABB) >> 1
140         : D == NORTH_EAST ? (b & ~FileHBB) << 9 : D == NORTH_WEST ? (b & ~FileABB) << 7
141         : D == SOUTH_EAST ? (b & ~FileHBB) >> 7 : D == SOUTH_WEST ? (b & ~FileABB) >> 9
142         : 0;
143 }
144
145
146 /// pawn_attacks_bb() returns the squares attacked by pawns of the given color
147 /// from the squares in the given bitboard.
148
149 template<Color C>
150 constexpr Bitboard pawn_attacks_bb(Bitboard b) {
151   return C == WHITE ? shift<NORTH_WEST>(b) | shift<NORTH_EAST>(b)
152                     : shift<SOUTH_WEST>(b) | shift<SOUTH_EAST>(b);
153 }
154
155 inline Bitboard pawn_attacks_bb(Color c, Square s) {
156
157   assert(is_ok(s));
158   return PawnAttacks[c][s];
159 }
160
161 /// line_bb() returns a bitboard representing an entire line (from board edge
162 /// to board edge) that intersects the two given squares. If the given squares
163 /// are not on a same file/rank/diagonal, the function returns 0. For instance,
164 /// line_bb(SQ_C4, SQ_F7) will return a bitboard with the A2-G8 diagonal.
165
166 inline Bitboard line_bb(Square s1, Square s2) {
167
168   assert(is_ok(s1) && is_ok(s2));
169
170   return LineBB[s1][s2];
171 }
172
173
174 /// between_bb(s1, s2) returns a bitboard representing the squares in the semi-open
175 /// segment between the squares s1 and s2 (excluding s1 but including s2). If the
176 /// given squares are not on a same file/rank/diagonal, it returns s2. For instance,
177 /// between_bb(SQ_C4, SQ_F7) will return a bitboard with squares D5, E6 and F7, but
178 /// between_bb(SQ_E6, SQ_F8) will return a bitboard with the square F8. This trick
179 /// allows to generate non-king evasion moves faster: the defending piece must either
180 /// interpose itself to cover the check or capture the checking piece.
181
182 inline Bitboard between_bb(Square s1, Square s2) {
183
184   assert(is_ok(s1) && is_ok(s2));
185
186   return BetweenBB[s1][s2];
187 }
188
189 /// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
190 /// straight or on a diagonal line.
191
192 inline bool aligned(Square s1, Square s2, Square s3) {
193   return line_bb(s1, s2) & s3;
194 }
195
196
197 /// distance() functions return the distance between x and y, defined as the
198 /// number of steps for a king in x to reach y.
199
200 template<typename T1 = Square> inline int distance(Square x, Square y);
201 template<> inline int distance<File>(Square x, Square y) { return std::abs(file_of(x) - file_of(y)); }
202 template<> inline int distance<Rank>(Square x, Square y) { return std::abs(rank_of(x) - rank_of(y)); }
203 template<> inline int distance<Square>(Square x, Square y) { return SquareDistance[x][y]; }
204
205 inline int edge_distance(File f) { return std::min(f, File(FILE_H - f)); }
206
207 /// attacks_bb(Square) returns the pseudo attacks of the give piece type
208 /// assuming an empty board.
209
210 template<PieceType Pt>
211 inline Bitboard attacks_bb(Square s) {
212
213   assert((Pt != PAWN) && (is_ok(s)));
214
215   return PseudoAttacks[Pt][s];
216 }
217
218
219 /// attacks_bb(Square, Bitboard) returns the attacks by the given piece
220 /// assuming the board is occupied according to the passed Bitboard.
221 /// Sliding piece attacks do not continue passed an occupied square.
222
223 template<PieceType Pt>
224 inline Bitboard attacks_bb(Square s, Bitboard occupied) {
225
226   assert((Pt != PAWN) && (is_ok(s)));
227
228   switch (Pt)
229   {
230   case BISHOP: return BishopMagics[s].attacks[BishopMagics[s].index(occupied)];
231   case ROOK  : return   RookMagics[s].attacks[  RookMagics[s].index(occupied)];
232   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
233   default    : return PseudoAttacks[Pt][s];
234   }
235 }
236
237 inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
238
239   assert((pt != PAWN) && (is_ok(s)));
240
241   switch (pt)
242   {
243   case BISHOP: return attacks_bb<BISHOP>(s, occupied);
244   case ROOK  : return attacks_bb<  ROOK>(s, occupied);
245   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
246   default    : return PseudoAttacks[pt][s];
247   }
248 }
249
250
251 /// popcount() counts the number of non-zero bits in a bitboard
252
253 inline int popcount(Bitboard b) {
254
255 #ifndef USE_POPCNT
256
257   union { Bitboard bb; uint16_t u[4]; } v = { b };
258   return PopCnt16[v.u[0]] + PopCnt16[v.u[1]] + PopCnt16[v.u[2]] + PopCnt16[v.u[3]];
259
260 #elif defined(_MSC_VER) || defined(__INTEL_COMPILER)
261
262   return (int)_mm_popcnt_u64(b);
263
264 #else // Assumed gcc or compatible compiler
265
266   return __builtin_popcountll(b);
267
268 #endif
269 }
270
271
272 /// lsb() and msb() return the least/most significant bit in a non-zero bitboard
273
274 #if defined(__GNUC__)  // GCC, Clang, ICC
275
276 inline Square lsb(Bitboard b) {
277   assert(b);
278   return Square(__builtin_ctzll(b));
279 }
280
281 inline Square msb(Bitboard b) {
282   assert(b);
283   return Square(63 ^ __builtin_clzll(b));
284 }
285
286 #elif defined(_MSC_VER)  // MSVC
287
288 #ifdef _WIN64  // MSVC, WIN64
289
290 inline Square lsb(Bitboard b) {
291   assert(b);
292   unsigned long idx;
293   _BitScanForward64(&idx, b);
294   return (Square) idx;
295 }
296
297 inline Square msb(Bitboard b) {
298   assert(b);
299   unsigned long idx;
300   _BitScanReverse64(&idx, b);
301   return (Square) idx;
302 }
303
304 #else  // MSVC, WIN32
305
306 inline Square lsb(Bitboard b) {
307   assert(b);
308   unsigned long idx;
309
310   if (b & 0xffffffff) {
311       _BitScanForward(&idx, int32_t(b));
312       return Square(idx);
313   } else {
314       _BitScanForward(&idx, int32_t(b >> 32));
315       return Square(idx + 32);
316   }
317 }
318
319 inline Square msb(Bitboard b) {
320   assert(b);
321   unsigned long idx;
322
323   if (b >> 32) {
324       _BitScanReverse(&idx, int32_t(b >> 32));
325       return Square(idx + 32);
326   } else {
327       _BitScanReverse(&idx, int32_t(b));
328       return Square(idx);
329   }
330 }
331
332 #endif
333
334 #else  // Compiler is neither GCC nor MSVC compatible
335
336 #error "Compiler not supported."
337
338 #endif
339
340 /// least_significant_square_bb() returns the bitboard of the least significant
341 /// square of a non-zero bitboard. It is equivalent to square_bb(lsb(bb)).
342
343 inline Bitboard least_significant_square_bb(Bitboard b) {
344   assert(b);
345   return b & -b;
346 }
347
348 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard
349
350 inline Square pop_lsb(Bitboard& b) {
351   assert(b);
352   const Square s = lsb(b);
353   b &= b - 1;
354   return s;
355 }
356
357 } // namespace Stockfish
358
359 #endif // #ifndef BITBOARD_H_INCLUDED