b8eb3220a776b026a890d031af7e6db7368fac69
[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-2010 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
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
22 #if !defined(BITBOARD_H_INCLUDED)
23 #define BITBOARD_H_INCLUDED
24
25 ////
26 //// Includes
27 ////
28
29 #include "piece.h"
30 #include "square.h"
31 #include "types.h"
32
33
34 ////
35 //// Constants and variables
36 ////
37
38 const Bitboard EmptyBoardBB = 0;
39
40 const Bitboard FileABB = 0x0101010101010101ULL;
41 const Bitboard FileBBB = FileABB << 1;
42 const Bitboard FileCBB = FileABB << 2;
43 const Bitboard FileDBB = FileABB << 3;
44 const Bitboard FileEBB = FileABB << 4;
45 const Bitboard FileFBB = FileABB << 5;
46 const Bitboard FileGBB = FileABB << 6;
47 const Bitboard FileHBB = FileABB << 7;
48
49 const Bitboard Rank1BB = 0xFF;
50 const Bitboard Rank2BB = Rank1BB << (8 * 1);
51 const Bitboard Rank3BB = Rank1BB << (8 * 2);
52 const Bitboard Rank4BB = Rank1BB << (8 * 3);
53 const Bitboard Rank5BB = Rank1BB << (8 * 4);
54 const Bitboard Rank6BB = Rank1BB << (8 * 5);
55 const Bitboard Rank7BB = Rank1BB << (8 * 6);
56 const Bitboard Rank8BB = Rank1BB << (8 * 7);
57
58 extern const Bitboard SquaresByColorBB[2];
59 extern const Bitboard FileBB[8];
60 extern const Bitboard NeighboringFilesBB[8];
61 extern const Bitboard ThisAndNeighboringFilesBB[8];
62 extern const Bitboard RankBB[8];
63 extern const Bitboard RelativeRankBB[2][8];
64 extern const Bitboard InFrontBB[2][8];
65
66 extern Bitboard SetMaskBB[65];
67 extern Bitboard ClearMaskBB[65];
68
69 extern Bitboard StepAttackBB[16][64];
70 extern Bitboard BetweenBB[64][64];
71
72 extern Bitboard SquaresInFrontMask[2][64];
73 extern Bitboard PassedPawnMask[2][64];
74 extern Bitboard AttackSpanMask[2][64];
75
76 extern const uint64_t RMult[64];
77 extern const int RShift[64];
78 extern Bitboard RMask[64];
79 extern int RAttackIndex[64];
80 extern Bitboard RAttacks[0x19000];
81
82 extern const uint64_t BMult[64];
83 extern const int BShift[64];
84 extern Bitboard BMask[64];
85 extern int BAttackIndex[64];
86 extern Bitboard BAttacks[0x1480];
87
88 extern Bitboard BishopPseudoAttacks[64];
89 extern Bitboard RookPseudoAttacks[64];
90 extern Bitboard QueenPseudoAttacks[64];
91
92 extern uint8_t BitCount8Bit[256];
93
94
95 ////
96 //// Inline functions
97 ////
98
99 /// Functions for testing whether a given bit is set in a bitboard, and for
100 /// setting and clearing bits.
101
102 inline Bitboard bit_is_set(Bitboard b, Square s) {
103   return b & SetMaskBB[s];
104 }
105
106 inline void set_bit(Bitboard *b, Square s) {
107   *b |= SetMaskBB[s];
108 }
109
110 inline void clear_bit(Bitboard *b, Square s) {
111   *b &= ClearMaskBB[s];
112 }
113
114
115 /// Functions used to update a bitboard after a move. This is faster
116 /// then calling a sequence of clear_bit() + set_bit()
117
118 inline Bitboard make_move_bb(Square from, Square to) {
119   return SetMaskBB[from] | SetMaskBB[to];
120 }
121
122 inline void do_move_bb(Bitboard *b, Bitboard move_bb) {
123   *b ^= move_bb;
124 }
125
126 /// rank_bb() and file_bb() take a file or a square as input, and return
127 /// a bitboard representing all squares on the given file or rank.
128
129 inline Bitboard rank_bb(Rank r) {
130   return RankBB[r];
131 }
132
133 inline Bitboard rank_bb(Square s) {
134   return rank_bb(square_rank(s));
135 }
136
137 inline Bitboard file_bb(File f) {
138   return FileBB[f];
139 }
140
141 inline Bitboard file_bb(Square s) {
142   return file_bb(square_file(s));
143 }
144
145
146 /// neighboring_files_bb takes a file or a square as input, and returns a
147 /// bitboard representing all squares on the neighboring files.
148
149 inline Bitboard neighboring_files_bb(File f) {
150   return NeighboringFilesBB[f];
151 }
152
153 inline Bitboard neighboring_files_bb(Square s) {
154   return NeighboringFilesBB[square_file(s)];
155 }
156
157
158 /// this_and_neighboring_files_bb takes a file or a square as input, and
159 /// returns a bitboard representing all squares on the given and neighboring
160 /// files.
161
162 inline Bitboard this_and_neighboring_files_bb(File f) {
163   return ThisAndNeighboringFilesBB[f];
164 }
165
166 inline Bitboard this_and_neighboring_files_bb(Square s) {
167   return ThisAndNeighboringFilesBB[square_file(s)];
168 }
169
170
171 /// relative_rank_bb() takes a color and a rank as input, and returns a bitboard
172 /// representing all squares on the given rank from the given color's point of
173 /// view. For instance, relative_rank_bb(WHITE, 7) gives all squares on the
174 /// 7th rank, while relative_rank_bb(BLACK, 7) gives all squares on the 2nd
175 /// rank.
176
177 inline Bitboard relative_rank_bb(Color c, Rank r) {
178   return RelativeRankBB[c][r];
179 }
180
181
182 /// in_front_bb() takes a color and a rank or square as input, and returns a
183 /// bitboard representing all the squares on all ranks in front of the rank
184 /// (or square), from the given color's point of view.  For instance,
185 /// in_front_bb(WHITE, RANK_5) will give all squares on ranks 6, 7 and 8, while
186 /// in_front_bb(BLACK, SQ_D3) will give all squares on ranks 1 and 2.
187
188 inline Bitboard in_front_bb(Color c, Rank r) {
189   return InFrontBB[c][r];
190 }
191
192 inline Bitboard in_front_bb(Color c, Square s) {
193   return InFrontBB[c][square_rank(s)];
194 }
195
196
197 /// behind_bb() takes a color and a rank or square as input, and returns a
198 /// bitboard representing all the squares on all ranks behind of the rank
199 /// (or square), from the given color's point of view.
200
201 inline Bitboard behind_bb(Color c, Rank r) {
202   return InFrontBB[opposite_color(c)][r];
203 }
204
205 inline Bitboard behind_bb(Color c, Square s) {
206   return InFrontBB[opposite_color(c)][square_rank(s)];
207 }
208
209
210 /// Functions for computing sliding attack bitboards. rook_attacks_bb(),
211 /// bishop_attacks_bb() and queen_attacks_bb() all take a square and a
212 /// bitboard of occupied squares as input, and return a bitboard representing
213 /// all squares attacked by a rook, bishop or queen on the given square.
214
215 #if defined(IS_64BIT)
216
217 inline Bitboard rook_attacks_bb(Square s, Bitboard blockers) {
218   Bitboard b = blockers & RMask[s];
219   return RAttacks[RAttackIndex[s] + ((b * RMult[s]) >> RShift[s])];
220 }
221
222 inline Bitboard bishop_attacks_bb(Square s, Bitboard blockers) {
223   Bitboard b = blockers & BMask[s];
224   return BAttacks[BAttackIndex[s] + ((b * BMult[s]) >> BShift[s])];
225 }
226
227 #else // if !defined(IS_64BIT)
228
229 inline Bitboard rook_attacks_bb(Square s, Bitboard blockers) {
230   Bitboard b = blockers & RMask[s];
231   return RAttacks[RAttackIndex[s] +
232                   (unsigned(int(b) * int(RMult[s]) ^
233                             int(b >> 32) * int(RMult[s] >> 32))
234                    >> RShift[s])];
235 }
236
237 inline Bitboard bishop_attacks_bb(Square s, Bitboard blockers) {
238   Bitboard b = blockers & BMask[s];
239   return BAttacks[BAttackIndex[s] +
240                   (unsigned(int(b) * int(BMult[s]) ^
241                             int(b >> 32) * int(BMult[s] >> 32))
242                    >> BShift[s])];
243 }
244
245 #endif
246
247 inline Bitboard queen_attacks_bb(Square s, Bitboard blockers) {
248   return rook_attacks_bb(s, blockers) | bishop_attacks_bb(s, blockers);
249 }
250
251
252 /// squares_between returns a bitboard representing all squares between
253 /// two squares.  For instance, squares_between(SQ_C4, SQ_F7) returns a
254 /// bitboard with the bits for square d5 and e6 set.  If s1 and s2 are not
255 /// on the same line, file or diagonal, EmptyBoardBB is returned.
256
257 inline Bitboard squares_between(Square s1, Square s2) {
258   return BetweenBB[s1][s2];
259 }
260
261
262 /// squares_in_front_of takes a color and a square as input, and returns a
263 /// bitboard representing all squares along the line in front of the square,
264 /// from the point of view of the given color. Definition of the table is:
265 /// SquaresInFrontOf[c][s] = in_front_bb(c, s) & file_bb(s)
266
267 inline Bitboard squares_in_front_of(Color c, Square s) {
268   return SquaresInFrontMask[c][s];
269 }
270
271
272 /// squares_behind is similar to squares_in_front, but returns the squares
273 /// behind the square instead of in front of the square.
274
275 inline Bitboard squares_behind(Color c, Square s) {
276   return SquaresInFrontMask[opposite_color(c)][s];
277 }
278
279
280 /// passed_pawn_mask takes a color and a square as input, and returns a
281 /// bitboard mask which can be used to test if a pawn of the given color on
282 /// the given square is a passed pawn. Definition of the table is:
283 /// PassedPawnMask[c][s] = in_front_bb(c, s) & this_and_neighboring_files_bb(s)
284
285 inline Bitboard passed_pawn_mask(Color c, Square s) {
286   return PassedPawnMask[c][s];
287 }
288
289
290 /// attack_span_mask takes a color and a square as input, and returns a bitboard
291 /// representing all squares that can be attacked by a pawn of the given color
292 /// when it moves along its file starting from the given square. Definition is:
293 /// AttackSpanMask[c][s] = in_front_bb(c, s) & neighboring_files_bb(s);
294
295 inline Bitboard attack_span_mask(Color c, Square s) {
296   return AttackSpanMask[c][s];
297 }
298
299
300 /// first_1() finds the least significant nonzero bit in a nonzero bitboard.
301 /// pop_1st_bit() finds and clears the least significant nonzero bit in a
302 /// nonzero bitboard.
303
304 #if defined(USE_BSFQ) // Assembly code by Heinz van Saanen
305
306 inline Square first_1(Bitboard b) {
307   Bitboard dummy;
308   __asm__("bsfq %1, %0": "=r"(dummy): "rm"(b) );
309   return (Square)(dummy);
310 }
311
312 inline Square pop_1st_bit(Bitboard* b) {
313   const Square s = first_1(*b);
314   *b &= ~(1ULL<<s);
315   return s;
316 }
317
318 #else // if !defined(USE_BSFQ)
319
320 extern Square first_1(Bitboard b);
321 extern Square pop_1st_bit(Bitboard* b);
322
323 #endif
324
325
326 ////
327 //// Prototypes
328 ////
329
330 extern void print_bitboard(Bitboard b);
331 extern void init_bitboards();
332
333
334 #endif // !defined(BITBOARD_H_INCLUDED)