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