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