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