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-2013 Marco Costalba, Joona Kiiski, Tord Romstad
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.
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.
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/>.
21 #if !defined(BITBOARD_H_INCLUDED)
22 #define BITBOARD_H_INCLUDED
29 void print(Bitboard b);
36 bool probe_kpk(Square wksq, Square wpsq, Square bksq, Color us);
42 extern Bitboard RMasks[SQUARE_NB];
43 extern Bitboard RMagics[SQUARE_NB];
44 extern Bitboard* RAttacks[SQUARE_NB];
45 extern unsigned RShifts[SQUARE_NB];
47 extern Bitboard BMasks[SQUARE_NB];
48 extern Bitboard BMagics[SQUARE_NB];
49 extern Bitboard* BAttacks[SQUARE_NB];
50 extern unsigned BShifts[SQUARE_NB];
52 extern Bitboard SquareBB[SQUARE_NB];
53 extern Bitboard FileBB[FILE_NB];
54 extern Bitboard RankBB[RANK_NB];
55 extern Bitboard AdjacentFilesBB[FILE_NB];
56 extern Bitboard ThisAndAdjacentFilesBB[FILE_NB];
57 extern Bitboard InFrontBB[COLOR_NB][RANK_NB];
58 extern Bitboard StepAttacksBB[PIECE_NB][SQUARE_NB];
59 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
60 extern Bitboard DistanceRingsBB[SQUARE_NB][8];
61 extern Bitboard ForwardBB[COLOR_NB][SQUARE_NB];
62 extern Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
63 extern Bitboard AttackSpanMask[COLOR_NB][SQUARE_NB];
64 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
66 const Bitboard BlackSquares = 0xAA55AA55AA55AA55ULL;
68 /// Overloads of bitwise operators between a Bitboard and a Square for testing
69 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
71 inline Bitboard operator&(Bitboard b, Square s) {
72 return b & SquareBB[s];
75 inline Bitboard& operator|=(Bitboard& b, Square s) {
76 return b |= SquareBB[s];
79 inline Bitboard& operator^=(Bitboard& b, Square s) {
80 return b ^= SquareBB[s];
83 inline Bitboard operator|(Bitboard b, Square s) {
84 return b | SquareBB[s];
87 inline Bitboard operator^(Bitboard b, Square s) {
88 return b ^ SquareBB[s];
92 /// more_than_one() returns true if in 'b' there is more than one bit set
94 inline bool more_than_one(Bitboard b) {
99 /// shift_bb() moves bitboard one step along direction Delta. Mainly for pawns.
101 template<Square Delta>
102 inline Bitboard shift_bb(Bitboard b) {
104 return Delta == DELTA_N ? b << 8 : Delta == DELTA_S ? b >> 8
105 : Delta == DELTA_NE ? (b & ~FileHBB) << 9 : Delta == DELTA_SE ? (b & ~FileHBB) >> 7
106 : Delta == DELTA_NW ? (b & ~FileABB) << 7 : Delta == DELTA_SW ? (b & ~FileABB) >> 9
111 /// rank_bb() and file_bb() take a file or a square as input and return
112 /// a bitboard representing all squares on the given file or rank.
114 inline Bitboard rank_bb(Rank r) {
118 inline Bitboard rank_bb(Square s) {
119 return RankBB[rank_of(s)];
122 inline Bitboard file_bb(File f) {
126 inline Bitboard file_bb(Square s) {
127 return FileBB[file_of(s)];
131 /// adjacent_files_bb takes a file as input and returns a bitboard representing
132 /// all squares on the adjacent files.
134 inline Bitboard adjacent_files_bb(File f) {
135 return AdjacentFilesBB[f];
139 /// this_and_adjacent_files_bb takes a file as input and returns a bitboard
140 /// representing all squares on the given and adjacent files.
142 inline Bitboard this_and_adjacent_files_bb(File f) {
143 return ThisAndAdjacentFilesBB[f];
147 /// in_front_bb() takes a color and a rank or square as input, and returns a
148 /// bitboard representing all the squares on all ranks in front of the rank
149 /// (or square), from the given color's point of view. For instance,
150 /// in_front_bb(WHITE, RANK_5) will give all squares on ranks 6, 7 and 8, while
151 /// in_front_bb(BLACK, SQ_D3) will give all squares on ranks 1 and 2.
153 inline Bitboard in_front_bb(Color c, Rank r) {
154 return InFrontBB[c][r];
157 inline Bitboard in_front_bb(Color c, Square s) {
158 return InFrontBB[c][rank_of(s)];
162 /// between_bb returns a bitboard representing all squares between two squares.
163 /// For instance, between_bb(SQ_C4, SQ_F7) returns a bitboard with the bits for
164 /// square d5 and e6 set. If s1 and s2 are not on the same line, file or diagonal,
167 inline Bitboard between_bb(Square s1, Square s2) {
168 return BetweenBB[s1][s2];
172 /// forward_bb takes a color and a square as input, and returns a bitboard
173 /// representing all squares along the line in front of the square, from the
174 /// point of view of the given color. Definition of the table is:
175 /// ForwardBB[c][s] = in_front_bb(c, s) & file_bb(s)
177 inline Bitboard forward_bb(Color c, Square s) {
178 return ForwardBB[c][s];
182 /// passed_pawn_mask takes a color and a square as input, and returns a
183 /// bitboard mask which can be used to test if a pawn of the given color on
184 /// the given square is a passed pawn. Definition of the table is:
185 /// PassedPawnMask[c][s] = in_front_bb(c, s) & this_and_adjacent_files_bb(s)
187 inline Bitboard passed_pawn_mask(Color c, Square s) {
188 return PassedPawnMask[c][s];
192 /// attack_span_mask takes a color and a square as input, and returns a bitboard
193 /// representing all squares that can be attacked by a pawn of the given color
194 /// when it moves along its file starting from the given square. Definition is:
195 /// AttackSpanMask[c][s] = in_front_bb(c, s) & adjacent_files_bb(s);
197 inline Bitboard attack_span_mask(Color c, Square s) {
198 return AttackSpanMask[c][s];
202 /// squares_aligned returns true if the squares s1, s2 and s3 are aligned
203 /// either on a straight or on a diagonal line.
205 inline bool squares_aligned(Square s1, Square s2, Square s3) {
206 return (BetweenBB[s1][s2] | BetweenBB[s1][s3] | BetweenBB[s2][s3])
207 & ( SquareBB[s1] | SquareBB[s2] | SquareBB[s3]);
211 /// same_color_squares() returns a bitboard representing all squares with
212 /// the same color of the given square.
214 inline Bitboard same_color_squares(Square s) {
215 return BlackSquares & s ? BlackSquares : ~BlackSquares;
219 /// Functions for computing sliding attack bitboards. Function attacks_bb() takes
220 /// a square and a bitboard of occupied squares as input, and returns a bitboard
221 /// representing all squares attacked by Pt (bishop or rook) on the given square.
222 template<PieceType Pt>
223 FORCE_INLINE unsigned magic_index(Square s, Bitboard occ) {
225 Bitboard* const Masks = Pt == ROOK ? RMasks : BMasks;
226 Bitboard* const Magics = Pt == ROOK ? RMagics : BMagics;
227 unsigned* const Shifts = Pt == ROOK ? RShifts : BShifts;
230 return unsigned(((occ & Masks[s]) * Magics[s]) >> Shifts[s]);
232 unsigned lo = unsigned(occ) & unsigned(Masks[s]);
233 unsigned hi = unsigned(occ >> 32) & unsigned(Masks[s] >> 32);
234 return (lo * unsigned(Magics[s]) ^ hi * unsigned(Magics[s] >> 32)) >> Shifts[s];
237 template<PieceType Pt>
238 inline Bitboard attacks_bb(Square s, Bitboard occ) {
239 return (Pt == ROOK ? RAttacks : BAttacks)[s][magic_index<Pt>(s, occ)];
243 /// lsb()/msb() finds the least/most significant bit in a nonzero bitboard.
244 /// pop_lsb() finds and clears the least significant bit in a nonzero bitboard.
246 #if defined(USE_BSFQ)
248 # if defined(_MSC_VER) && !defined(__INTEL_COMPILER)
250 FORCE_INLINE Square lsb(Bitboard b) {
252 _BitScanForward64(&index, b);
253 return (Square) index;
256 FORCE_INLINE Square msb(Bitboard b) {
258 _BitScanReverse64(&index, b);
259 return (Square) index;
262 # elif defined(__arm__)
264 FORCE_INLINE int lsb32(uint32_t v) {
265 __asm__("rbit %0, %1" : "=r"(v) : "r"(v));
266 return __builtin_clz(v);
269 FORCE_INLINE Square msb(Bitboard b) {
270 return (Square) (63 - __builtin_clzll(b));
273 FORCE_INLINE Square lsb(Bitboard b) {
274 return (Square) (uint32_t(b) ? lsb32(uint32_t(b)) : 32 + lsb32(uint32_t(b >> 32)));
279 FORCE_INLINE Square lsb(Bitboard b) { // Assembly code by Heinz van Saanen
281 __asm__("bsfq %1, %0": "=r"(index): "rm"(b) );
282 return (Square) index;
285 FORCE_INLINE Square msb(Bitboard b) {
287 __asm__("bsrq %1, %0": "=r"(index): "rm"(b) );
288 return (Square) index;
293 FORCE_INLINE Square pop_lsb(Bitboard* b) {
294 const Square s = lsb(*b);
299 #else // if !defined(USE_BSFQ)
301 extern Square msb(Bitboard b);
302 extern Square lsb(Bitboard b);
303 extern Square pop_lsb(Bitboard* b);
307 #endif // !defined(BITBOARD_H_INCLUDED)