Sync some common names
[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-2014 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 #ifndef BITBOARD_H_INCLUDED
22 #define BITBOARD_H_INCLUDED
23
24 #include "types.h"
25
26 namespace Bitboards {
27
28 void init();
29 const std::string pretty(Bitboard b);
30
31 }
32
33 namespace Bitbases {
34
35 void init_kpk();
36 bool probe_kpk(Square wksq, Square wpsq, Square bksq, Color us);
37
38 }
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 CACHE_LINE_ALIGNMENT
59
60 extern Bitboard RMasks[SQUARE_NB];
61 extern Bitboard RMagics[SQUARE_NB];
62 extern Bitboard* RAttacks[SQUARE_NB];
63 extern unsigned RShifts[SQUARE_NB];
64
65 extern Bitboard BMasks[SQUARE_NB];
66 extern Bitboard BMagics[SQUARE_NB];
67 extern Bitboard* BAttacks[SQUARE_NB];
68 extern unsigned BShifts[SQUARE_NB];
69
70 extern Bitboard SquareBB[SQUARE_NB];
71 extern Bitboard FileBB[FILE_NB];
72 extern Bitboard RankBB[RANK_NB];
73 extern Bitboard AdjacentFilesBB[FILE_NB];
74 extern Bitboard InFrontBB[COLOR_NB][RANK_NB];
75 extern Bitboard StepAttacksBB[PIECE_NB][SQUARE_NB];
76 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
77 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
78 extern Bitboard DistanceRingsBB[SQUARE_NB][8];
79 extern Bitboard ForwardBB[COLOR_NB][SQUARE_NB];
80 extern Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
81 extern Bitboard PawnAttackSpan[COLOR_NB][SQUARE_NB];
82 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
83
84 extern int SquareDistance[SQUARE_NB][SQUARE_NB];
85
86 const Bitboard DarkSquares = 0xAA55AA55AA55AA55ULL;
87
88 /// Overloads of bitwise operators between a Bitboard and a Square for testing
89 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
90
91 inline Bitboard operator&(Bitboard b, Square s) {
92   return b & SquareBB[s];
93 }
94
95 inline Bitboard& operator|=(Bitboard& b, Square s) {
96   return b |= SquareBB[s];
97 }
98
99 inline Bitboard& operator^=(Bitboard& b, Square s) {
100   return b ^= SquareBB[s];
101 }
102
103 inline Bitboard operator|(Bitboard b, Square s) {
104   return b | SquareBB[s];
105 }
106
107 inline Bitboard operator^(Bitboard b, Square s) {
108   return b ^ SquareBB[s];
109 }
110
111 inline bool more_than_one(Bitboard b) {
112   return b & (b - 1);
113 }
114
115 inline int square_distance(Square s1, Square s2) {
116   return SquareDistance[s1][s2];
117 }
118
119 inline int file_distance(Square s1, Square s2) {
120   return abs(file_of(s1) - file_of(s2));
121 }
122
123 inline int rank_distance(Square s1, Square s2) {
124   return abs(rank_of(s1) - rank_of(s2));
125 }
126
127
128 /// shift_bb() moves bitboard one step along direction Delta. Mainly for pawns.
129
130 template<Square Delta>
131 inline Bitboard shift_bb(Bitboard b) {
132
133   return  Delta == DELTA_N  ?  b             << 8 : Delta == DELTA_S  ?  b             >> 8
134         : Delta == DELTA_NE ? (b & ~FileHBB) << 9 : Delta == DELTA_SE ? (b & ~FileHBB) >> 7
135         : Delta == DELTA_NW ? (b & ~FileABB) << 7 : Delta == DELTA_SW ? (b & ~FileABB) >> 9
136         : 0;
137 }
138
139
140 /// rank_bb() and file_bb() take a file or a square as input and return
141 /// a bitboard representing all squares on the given file or rank.
142
143 inline Bitboard rank_bb(Rank r) {
144   return RankBB[r];
145 }
146
147 inline Bitboard rank_bb(Square s) {
148   return RankBB[rank_of(s)];
149 }
150
151 inline Bitboard file_bb(File f) {
152   return FileBB[f];
153 }
154
155 inline Bitboard file_bb(Square s) {
156   return FileBB[file_of(s)];
157 }
158
159
160 /// adjacent_files_bb() takes a file as input and returns a bitboard representing
161 /// all squares on the adjacent files.
162
163 inline Bitboard adjacent_files_bb(File f) {
164   return AdjacentFilesBB[f];
165 }
166
167
168 /// in_front_bb() takes a color and a rank as input, and returns a bitboard
169 /// representing all the squares on all ranks in front of the rank, from the
170 /// given color's point of view. For instance, in_front_bb(BLACK, RANK_3) will
171 /// give all squares on ranks 1 and 2.
172
173 inline Bitboard in_front_bb(Color c, Rank r) {
174   return InFrontBB[c][r];
175 }
176
177
178 /// between_bb() returns a bitboard representing all squares between two squares.
179 /// For instance, between_bb(SQ_C4, SQ_F7) returns a bitboard with the bits for
180 /// square d5 and e6 set.  If s1 and s2 are not on the same rank, file or diagonal,
181 /// 0 is returned.
182
183 inline Bitboard between_bb(Square s1, Square s2) {
184   return BetweenBB[s1][s2];
185 }
186
187
188 /// forward_bb() takes a color and a square as input, and returns a bitboard
189 /// representing all squares along the line in front of the square, from the
190 /// point of view of the given color. Definition of the table is:
191 /// ForwardBB[c][s] = in_front_bb(c, s) & file_bb(s)
192
193 inline Bitboard forward_bb(Color c, Square s) {
194   return ForwardBB[c][s];
195 }
196
197
198 /// pawn_attack_span() takes a color and a square as input, and returns a bitboard
199 /// representing all squares that can be attacked by a pawn of the given color
200 /// when it moves along its file starting from the given square. Definition is:
201 /// PawnAttackSpan[c][s] = in_front_bb(c, s) & adjacent_files_bb(s);
202
203 inline Bitboard pawn_attack_span(Color c, Square s) {
204   return PawnAttackSpan[c][s];
205 }
206
207
208 /// passed_pawn_mask() takes a color and a square as input, and returns a
209 /// bitboard mask which can be used to test if a pawn of the given color on
210 /// the given square is a passed pawn. Definition of the table is:
211 /// PassedPawnMask[c][s] = pawn_attack_span(c, s) | forward_bb(c, s)
212
213 inline Bitboard passed_pawn_mask(Color c, Square s) {
214   return PassedPawnMask[c][s];
215 }
216
217
218 /// squares_of_color() returns a bitboard representing all squares with the same
219 /// color of the given square.
220
221 inline Bitboard squares_of_color(Square s) {
222   return DarkSquares & s ? DarkSquares : ~DarkSquares;
223 }
224
225
226 /// aligned() returns true if the squares s1, s2 and s3 are aligned
227 /// either on a straight or on a diagonal line.
228
229 inline bool aligned(Square s1, Square s2, Square s3) {
230   return LineBB[s1][s2] & s3;
231 }
232
233
234 /// Functions for computing sliding attack bitboards. Function attacks_bb() takes
235 /// a square and a bitboard of occupied squares as input, and returns a bitboard
236 /// representing all squares attacked by Pt (bishop or rook) on the given square.
237 template<PieceType Pt>
238 FORCE_INLINE unsigned magic_index(Square s, Bitboard occ) {
239
240   Bitboard* const Masks  = Pt == ROOK ? RMasks  : BMasks;
241   Bitboard* const Magics = Pt == ROOK ? RMagics : BMagics;
242   unsigned* const Shifts = Pt == ROOK ? RShifts : BShifts;
243
244   if (Is64Bit)
245       return unsigned(((occ & Masks[s]) * Magics[s]) >> Shifts[s]);
246
247   unsigned lo = unsigned(occ) & unsigned(Masks[s]);
248   unsigned hi = unsigned(occ >> 32) & unsigned(Masks[s] >> 32);
249   return (lo * unsigned(Magics[s]) ^ hi * unsigned(Magics[s] >> 32)) >> Shifts[s];
250 }
251
252 template<PieceType Pt>
253 inline Bitboard attacks_bb(Square s, Bitboard occ) {
254   return (Pt == ROOK ? RAttacks : BAttacks)[s][magic_index<Pt>(s, occ)];
255 }
256
257 inline Bitboard attacks_bb(Piece pc, Square s, Bitboard occ) {
258
259   switch (type_of(pc))
260   {
261   case BISHOP: return attacks_bb<BISHOP>(s, occ);
262   case ROOK  : return attacks_bb<ROOK>(s, occ);
263   case QUEEN : return attacks_bb<BISHOP>(s, occ) | attacks_bb<ROOK>(s, occ);
264   default    : return StepAttacksBB[pc][s];
265   }
266 }
267
268 /// lsb()/msb() finds the least/most significant bit in a non-zero bitboard.
269 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard.
270
271 #ifdef USE_BSFQ
272
273 #  if defined(_MSC_VER) && !defined(__INTEL_COMPILER)
274
275 FORCE_INLINE Square lsb(Bitboard b) {
276   unsigned long idx;
277   _BitScanForward64(&idx, b);
278   return (Square) idx;
279 }
280
281 FORCE_INLINE Square msb(Bitboard b) {
282   unsigned long idx;
283   _BitScanReverse64(&idx, b);
284   return (Square) idx;
285 }
286
287 #  elif defined(__arm__)
288
289 FORCE_INLINE int lsb32(uint32_t v) {
290   __asm__("rbit %0, %1" : "=r"(v) : "r"(v));
291   return __builtin_clz(v);
292 }
293
294 FORCE_INLINE Square msb(Bitboard b) {
295   return (Square) (63 - __builtin_clzll(b));
296 }
297
298 FORCE_INLINE Square lsb(Bitboard b) {
299   return (Square) (uint32_t(b) ? lsb32(uint32_t(b)) : 32 + lsb32(uint32_t(b >> 32)));
300 }
301
302 #  else
303
304 FORCE_INLINE Square lsb(Bitboard b) { // Assembly code by Heinz van Saanen
305   Bitboard idx;
306   __asm__("bsfq %1, %0": "=r"(idx): "rm"(b) );
307   return (Square) idx;
308 }
309
310 FORCE_INLINE Square msb(Bitboard b) {
311   Bitboard idx;
312   __asm__("bsrq %1, %0": "=r"(idx): "rm"(b) );
313   return (Square) idx;
314 }
315
316 #  endif
317
318 FORCE_INLINE Square pop_lsb(Bitboard* b) {
319   const Square s = lsb(*b);
320   *b &= *b - 1;
321   return s;
322 }
323
324 #else // if defined(USE_BSFQ)
325
326 extern Square msb(Bitboard b);
327 extern Square lsb(Bitboard b);
328 extern Square pop_lsb(Bitboard* b);
329
330 #endif
331
332 /// frontmost_sq() and backmost_sq() find the square corresponding to the
333 /// most/least advanced bit relative to the given color.
334
335 inline Square frontmost_sq(Color c, Bitboard b) { return c == WHITE ? msb(b) : lsb(b); }
336 inline Square  backmost_sq(Color c, Bitboard b) { return c == WHITE ? lsb(b) : msb(b); }
337
338 #endif // #ifndef BITBOARD_H_INCLUDED