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