2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
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.
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.
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/>.
19 #ifndef BITBOARD_H_INCLUDED
20 #define BITBOARD_H_INCLUDED
31 std::string pretty(Bitboard b);
33 } // namespace Stockfish::Bitboards
35 constexpr Bitboard AllSquares = ~Bitboard(0);
36 constexpr Bitboard DarkSquares = 0xAA55AA55AA55AA55ULL;
38 constexpr Bitboard FileABB = 0x0101010101010101ULL;
39 constexpr Bitboard FileBBB = FileABB << 1;
40 constexpr Bitboard FileCBB = FileABB << 2;
41 constexpr Bitboard FileDBB = FileABB << 3;
42 constexpr Bitboard FileEBB = FileABB << 4;
43 constexpr Bitboard FileFBB = FileABB << 5;
44 constexpr Bitboard FileGBB = FileABB << 6;
45 constexpr Bitboard FileHBB = FileABB << 7;
47 constexpr Bitboard Rank1BB = 0xFF;
48 constexpr Bitboard Rank2BB = Rank1BB << (8 * 1);
49 constexpr Bitboard Rank3BB = Rank1BB << (8 * 2);
50 constexpr Bitboard Rank4BB = Rank1BB << (8 * 3);
51 constexpr Bitboard Rank5BB = Rank1BB << (8 * 4);
52 constexpr Bitboard Rank6BB = Rank1BB << (8 * 5);
53 constexpr Bitboard Rank7BB = Rank1BB << (8 * 6);
54 constexpr Bitboard Rank8BB = Rank1BB << (8 * 7);
56 constexpr Bitboard QueenSide = FileABB | FileBBB | FileCBB | FileDBB;
57 constexpr Bitboard CenterFiles = FileCBB | FileDBB | FileEBB | FileFBB;
58 constexpr Bitboard KingSide = FileEBB | FileFBB | FileGBB | FileHBB;
59 constexpr Bitboard Center = (FileDBB | FileEBB) & (Rank4BB | Rank5BB);
61 constexpr Bitboard KingFlank[FILE_NB] = {
62 QueenSide ^ FileDBB, QueenSide, QueenSide,
63 CenterFiles, CenterFiles,
64 KingSide, KingSide, KingSide ^ FileEBB
67 extern uint8_t PopCnt16[1 << 16];
68 extern uint8_t SquareDistance[SQUARE_NB][SQUARE_NB];
70 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
71 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
72 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
73 extern Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
76 /// Magic holds all magic bitboards relevant data for a single square
83 // Compute the attack's index using the 'magic bitboards' approach
84 unsigned index(Bitboard occupied) const {
87 return unsigned(pext(occupied, mask));
90 return unsigned(((occupied & mask) * magic) >> shift);
92 unsigned lo = unsigned(occupied) & unsigned(mask);
93 unsigned hi = unsigned(occupied >> 32) & unsigned(mask >> 32);
94 return (lo * unsigned(magic) ^ hi * unsigned(magic >> 32)) >> shift;
98 extern Magic RookMagics[SQUARE_NB];
99 extern Magic BishopMagics[SQUARE_NB];
101 inline Bitboard square_bb(Square s) {
107 /// Overloads of bitwise operators between a Bitboard and a Square for testing
108 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
110 inline Bitboard operator&( Bitboard b, Square s) { return b & square_bb(s); }
111 inline Bitboard operator|( Bitboard b, Square s) { return b | square_bb(s); }
112 inline Bitboard operator^( Bitboard b, Square s) { return b ^ square_bb(s); }
113 inline Bitboard& operator|=(Bitboard& b, Square s) { return b |= square_bb(s); }
114 inline Bitboard& operator^=(Bitboard& b, Square s) { return b ^= square_bb(s); }
116 inline Bitboard operator&(Square s, Bitboard b) { return b & s; }
117 inline Bitboard operator|(Square s, Bitboard b) { return b | s; }
118 inline Bitboard operator^(Square s, Bitboard b) { return b ^ s; }
120 inline Bitboard operator|(Square s1, Square s2) { return square_bb(s1) | s2; }
122 constexpr bool more_than_one(Bitboard b) {
127 constexpr bool opposite_colors(Square s1, Square s2) {
128 return (s1 + rank_of(s1) + s2 + rank_of(s2)) & 1;
132 /// rank_bb() and file_bb() return a bitboard representing all the squares on
133 /// the given file or rank.
135 constexpr Bitboard rank_bb(Rank r) {
136 return Rank1BB << (8 * r);
139 constexpr Bitboard rank_bb(Square s) {
140 return rank_bb(rank_of(s));
143 constexpr Bitboard file_bb(File f) {
147 constexpr Bitboard file_bb(Square s) {
148 return file_bb(file_of(s));
152 /// shift() moves a bitboard one or two steps as specified by the direction D
154 template<Direction D>
155 constexpr Bitboard shift(Bitboard b) {
156 return D == NORTH ? b << 8 : D == SOUTH ? b >> 8
157 : D == NORTH+NORTH? b <<16 : D == SOUTH+SOUTH? b >>16
158 : D == EAST ? (b & ~FileHBB) << 1 : D == WEST ? (b & ~FileABB) >> 1
159 : D == NORTH_EAST ? (b & ~FileHBB) << 9 : D == NORTH_WEST ? (b & ~FileABB) << 7
160 : D == SOUTH_EAST ? (b & ~FileHBB) >> 7 : D == SOUTH_WEST ? (b & ~FileABB) >> 9
165 /// pawn_attacks_bb() returns the squares attacked by pawns of the given color
166 /// from the squares in the given bitboard.
169 constexpr Bitboard pawn_attacks_bb(Bitboard b) {
170 return C == WHITE ? shift<NORTH_WEST>(b) | shift<NORTH_EAST>(b)
171 : shift<SOUTH_WEST>(b) | shift<SOUTH_EAST>(b);
174 inline Bitboard pawn_attacks_bb(Color c, Square s) {
177 return PawnAttacks[c][s];
181 /// pawn_double_attacks_bb() returns the squares doubly attacked by pawns of the
182 /// given color from the squares in the given bitboard.
185 constexpr Bitboard pawn_double_attacks_bb(Bitboard b) {
186 return C == WHITE ? shift<NORTH_WEST>(b) & shift<NORTH_EAST>(b)
187 : shift<SOUTH_WEST>(b) & shift<SOUTH_EAST>(b);
191 /// adjacent_files_bb() returns a bitboard representing all the squares on the
192 /// adjacent files of a given square.
194 constexpr Bitboard adjacent_files_bb(Square s) {
195 return shift<EAST>(file_bb(s)) | shift<WEST>(file_bb(s));
199 /// line_bb() returns a bitboard representing an entire line (from board edge
200 /// to board edge) that intersects the two given squares. If the given squares
201 /// are not on a same file/rank/diagonal, the function returns 0. For instance,
202 /// line_bb(SQ_C4, SQ_F7) will return a bitboard with the A2-G8 diagonal.
204 inline Bitboard line_bb(Square s1, Square s2) {
206 assert(is_ok(s1) && is_ok(s2));
208 return LineBB[s1][s2];
212 /// between_bb(s1, s2) returns a bitboard representing the squares in the semi-open
213 /// segment between the squares s1 and s2 (excluding s1 but including s2). If the
214 /// given squares are not on a same file/rank/diagonal, it returns s2. For instance,
215 /// between_bb(SQ_C4, SQ_F7) will return a bitboard with squares D5, E6 and F7, but
216 /// between_bb(SQ_E6, SQ_F8) will return a bitboard with the square F8. This trick
217 /// allows to generate non-king evasion moves faster: the defending piece must either
218 /// interpose itself to cover the check or capture the checking piece.
220 inline Bitboard between_bb(Square s1, Square s2) {
222 assert(is_ok(s1) && is_ok(s2));
224 return BetweenBB[s1][s2];
228 /// forward_ranks_bb() returns a bitboard representing the squares on the ranks in
229 /// front of the given one, from the point of view of the given color. For instance,
230 /// forward_ranks_bb(BLACK, SQ_D3) will return the 16 squares on ranks 1 and 2.
232 constexpr Bitboard forward_ranks_bb(Color c, Square s) {
233 return c == WHITE ? ~Rank1BB << 8 * relative_rank(WHITE, s)
234 : ~Rank8BB >> 8 * relative_rank(BLACK, s);
238 /// forward_file_bb() returns a bitboard representing all the squares along the
239 /// line in front of the given one, from the point of view of the given color.
241 constexpr Bitboard forward_file_bb(Color c, Square s) {
242 return forward_ranks_bb(c, s) & file_bb(s);
246 /// pawn_attack_span() returns a bitboard representing all the squares that can
247 /// be attacked by a pawn of the given color when it moves along its file, starting
248 /// from the given square.
250 constexpr Bitboard pawn_attack_span(Color c, Square s) {
251 return forward_ranks_bb(c, s) & adjacent_files_bb(s);
255 /// passed_pawn_span() returns a bitboard which can be used to test if a pawn of
256 /// the given color and on the given square is a passed pawn.
258 constexpr Bitboard passed_pawn_span(Color c, Square s) {
259 return pawn_attack_span(c, s) | forward_file_bb(c, s);
263 /// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
264 /// straight or on a diagonal line.
266 inline bool aligned(Square s1, Square s2, Square s3) {
267 return line_bb(s1, s2) & s3;
271 /// distance() functions return the distance between x and y, defined as the
272 /// number of steps for a king in x to reach y.
274 template<typename T1 = Square> inline int distance(Square x, Square y);
275 template<> inline int distance<File>(Square x, Square y) { return std::abs(file_of(x) - file_of(y)); }
276 template<> inline int distance<Rank>(Square x, Square y) { return std::abs(rank_of(x) - rank_of(y)); }
277 template<> inline int distance<Square>(Square x, Square y) { return SquareDistance[x][y]; }
279 inline int edge_distance(File f) { return std::min(f, File(FILE_H - f)); }
280 inline int edge_distance(Rank r) { return std::min(r, Rank(RANK_8 - r)); }
283 /// attacks_bb(Square) returns the pseudo attacks of the give piece type
284 /// assuming an empty board.
286 template<PieceType Pt>
287 inline Bitboard attacks_bb(Square s) {
289 assert((Pt != PAWN) && (is_ok(s)));
291 return PseudoAttacks[Pt][s];
295 /// attacks_bb(Square, Bitboard) returns the attacks by the given piece
296 /// assuming the board is occupied according to the passed Bitboard.
297 /// Sliding piece attacks do not continue passed an occupied square.
299 template<PieceType Pt>
300 inline Bitboard attacks_bb(Square s, Bitboard occupied) {
302 assert((Pt != PAWN) && (is_ok(s)));
306 case BISHOP: return BishopMagics[s].attacks[BishopMagics[s].index(occupied)];
307 case ROOK : return RookMagics[s].attacks[ RookMagics[s].index(occupied)];
308 case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
309 default : return PseudoAttacks[Pt][s];
313 inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
315 assert((pt != PAWN) && (is_ok(s)));
319 case BISHOP: return attacks_bb<BISHOP>(s, occupied);
320 case ROOK : return attacks_bb< ROOK>(s, occupied);
321 case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
322 default : return PseudoAttacks[pt][s];
327 /// popcount() counts the number of non-zero bits in a bitboard
329 inline int popcount(Bitboard b) {
333 union { Bitboard bb; uint16_t u[4]; } v = { b };
334 return PopCnt16[v.u[0]] + PopCnt16[v.u[1]] + PopCnt16[v.u[2]] + PopCnt16[v.u[3]];
336 #elif defined(_MSC_VER) || defined(__INTEL_COMPILER)
338 return (int)_mm_popcnt_u64(b);
340 #else // Assumed gcc or compatible compiler
342 return __builtin_popcountll(b);
348 /// lsb() and msb() return the least/most significant bit in a non-zero bitboard
350 #if defined(__GNUC__) // GCC, Clang, ICC
352 inline Square lsb(Bitboard b) {
354 return Square(__builtin_ctzll(b));
357 inline Square msb(Bitboard b) {
359 return Square(63 ^ __builtin_clzll(b));
362 #elif defined(_MSC_VER) // MSVC
364 #ifdef _WIN64 // MSVC, WIN64
366 inline Square lsb(Bitboard b) {
369 _BitScanForward64(&idx, b);
373 inline Square msb(Bitboard b) {
376 _BitScanReverse64(&idx, b);
382 inline Square lsb(Bitboard b) {
386 if (b & 0xffffffff) {
387 _BitScanForward(&idx, int32_t(b));
390 _BitScanForward(&idx, int32_t(b >> 32));
391 return Square(idx + 32);
395 inline Square msb(Bitboard b) {
400 _BitScanReverse(&idx, int32_t(b >> 32));
401 return Square(idx + 32);
403 _BitScanReverse(&idx, int32_t(b));
410 #else // Compiler is neither GCC nor MSVC compatible
412 #error "Compiler not supported."
416 /// least_significant_square_bb() returns the bitboard of the least significant
417 /// square of a non-zero bitboard. It is equivalent to square_bb(lsb(bb)).
419 inline Bitboard least_significant_square_bb(Bitboard b) {
424 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard
426 inline Square pop_lsb(Bitboard& b) {
428 const Square s = lsb(b);
434 /// frontmost_sq() returns the most advanced square for the given color,
435 /// requires a non-zero bitboard.
436 inline Square frontmost_sq(Color c, Bitboard b) {
438 return c == WHITE ? msb(b) : lsb(b);
441 } // namespace Stockfish
443 #endif // #ifndef BITBOARD_H_INCLUDED