Use constexpr when makes sense
[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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2017 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
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 <string>
25
26 #include "types.h"
27
28 namespace Bitbases {
29
30 void init();
31 bool probe(Square wksq, Square wpsq, Square bksq, Color us);
32
33 }
34
35 namespace Bitboards {
36
37 void init();
38 const std::string pretty(Bitboard b);
39
40 }
41
42 const Bitboard AllSquares = ~Bitboard(0);
43 const Bitboard DarkSquares = 0xAA55AA55AA55AA55ULL;
44
45 const Bitboard FileABB = 0x0101010101010101ULL;
46 const Bitboard FileBBB = FileABB << 1;
47 const Bitboard FileCBB = FileABB << 2;
48 const Bitboard FileDBB = FileABB << 3;
49 const Bitboard FileEBB = FileABB << 4;
50 const Bitboard FileFBB = FileABB << 5;
51 const Bitboard FileGBB = FileABB << 6;
52 const Bitboard FileHBB = FileABB << 7;
53
54 const Bitboard Rank1BB = 0xFF;
55 const Bitboard Rank2BB = Rank1BB << (8 * 1);
56 const Bitboard Rank3BB = Rank1BB << (8 * 2);
57 const Bitboard Rank4BB = Rank1BB << (8 * 3);
58 const Bitboard Rank5BB = Rank1BB << (8 * 4);
59 const Bitboard Rank6BB = Rank1BB << (8 * 5);
60 const Bitboard Rank7BB = Rank1BB << (8 * 6);
61 const Bitboard Rank8BB = Rank1BB << (8 * 7);
62
63 extern int SquareDistance[SQUARE_NB][SQUARE_NB];
64
65 extern Bitboard SquareBB[SQUARE_NB];
66 extern Bitboard FileBB[FILE_NB];
67 extern Bitboard RankBB[RANK_NB];
68 extern Bitboard AdjacentFilesBB[FILE_NB];
69 extern Bitboard ForwardRanksBB[COLOR_NB][RANK_NB];
70 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
71 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
72 extern Bitboard DistanceRingBB[SQUARE_NB][8];
73 extern Bitboard ForwardFileBB[COLOR_NB][SQUARE_NB];
74 extern Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
75 extern Bitboard PawnAttackSpan[COLOR_NB][SQUARE_NB];
76 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
77 extern Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
78
79
80 /// Magic holds all magic bitboards relevant data for a single square
81 struct Magic {
82   Bitboard  mask;
83   Bitboard  magic;
84   Bitboard* attacks;
85   unsigned  shift;
86
87   // Compute the attack's index using the 'magic bitboards' approach
88   unsigned index(Bitboard occupied) const {
89
90     if (HasPext)
91         return unsigned(pext(occupied, mask));
92
93     if (Is64Bit)
94         return unsigned(((occupied & mask) * magic) >> shift);
95
96     unsigned lo = unsigned(occupied) & unsigned(mask);
97     unsigned hi = unsigned(occupied >> 32) & unsigned(mask >> 32);
98     return (lo * unsigned(magic) ^ hi * unsigned(magic >> 32)) >> shift;
99   }
100 };
101
102 extern Magic RookMagics[SQUARE_NB];
103 extern Magic BishopMagics[SQUARE_NB];
104
105
106 /// Overloads of bitwise operators between a Bitboard and a Square for testing
107 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
108
109 inline Bitboard operator&(Bitboard b, Square s) {
110   return b & SquareBB[s];
111 }
112
113 inline Bitboard operator|(Bitboard b, Square s) {
114   return b | SquareBB[s];
115 }
116
117 inline Bitboard operator^(Bitboard b, Square s) {
118   return b ^ SquareBB[s];
119 }
120
121 inline Bitboard& operator|=(Bitboard& b, Square s) {
122   return b |= SquareBB[s];
123 }
124
125 inline Bitboard& operator^=(Bitboard& b, Square s) {
126   return b ^= SquareBB[s];
127 }
128
129 constexpr bool more_than_one(Bitboard b) {
130   return b & (b - 1);
131 }
132
133
134 /// rank_bb() and file_bb() return a bitboard representing all the squares on
135 /// the given file or rank.
136
137 inline Bitboard rank_bb(Rank r) {
138   return RankBB[r];
139 }
140
141 inline Bitboard rank_bb(Square s) {
142   return RankBB[rank_of(s)];
143 }
144
145 inline Bitboard file_bb(File f) {
146   return FileBB[f];
147 }
148
149 inline Bitboard file_bb(Square s) {
150   return FileBB[file_of(s)];
151 }
152
153
154 /// shift() moves a bitboard one step along direction D. Mainly for pawns
155
156 template<Square D>
157 constexpr Bitboard shift(Bitboard b) {
158   return  D == NORTH      ?  b             << 8 : D == SOUTH      ?  b             >> 8
159         : D == NORTH_EAST ? (b & ~FileHBB) << 9 : D == SOUTH_EAST ? (b & ~FileHBB) >> 7
160         : D == NORTH_WEST ? (b & ~FileABB) << 7 : D == SOUTH_WEST ? (b & ~FileABB) >> 9
161         : 0;
162 }
163
164
165 /// adjacent_files_bb() returns a bitboard representing all the squares on the
166 /// adjacent files of the given one.
167
168 inline Bitboard adjacent_files_bb(File f) {
169   return AdjacentFilesBB[f];
170 }
171
172
173 /// between_bb() returns a bitboard representing all the squares between the two
174 /// given ones. For instance, between_bb(SQ_C4, SQ_F7) returns a bitboard with
175 /// the bits for square d5 and e6 set. If s1 and s2 are not on the same rank, file
176 /// or diagonal, 0 is returned.
177
178 inline Bitboard between_bb(Square s1, Square s2) {
179   return BetweenBB[s1][s2];
180 }
181
182
183 /// forward_ranks_bb() returns a bitboard representing all the squares on all the ranks
184 /// in front of the given one, from the point of view of the given color. For
185 /// instance, forward_ranks_bb(BLACK, SQ_D3) will return the 16 squares on ranks 1 and 2.
186
187 inline Bitboard forward_ranks_bb(Color c, Square s) {
188   return ForwardRanksBB[c][rank_of(s)];
189 }
190
191
192 /// forward_file_bb() returns a bitboard representing all the squares along the line
193 /// in front of the given one, from the point of view of the given color:
194 ///      ForwardFileBB[c][s] = forward_ranks_bb(c, s) & file_bb(s)
195
196 inline Bitboard forward_file_bb(Color c, Square s) {
197   return ForwardFileBB[c][s];
198 }
199
200
201 /// pawn_attack_span() returns a bitboard representing all the squares that can be
202 /// attacked by a pawn of the given color when it moves along its file, starting
203 /// from the given square:
204 ///      PawnAttackSpan[c][s] = forward_ranks_bb(c, s) & adjacent_files_bb(file_of(s));
205
206 inline Bitboard pawn_attack_span(Color c, Square s) {
207   return PawnAttackSpan[c][s];
208 }
209
210
211 /// passed_pawn_mask() returns a bitboard mask which can be used to test if a
212 /// pawn of the given color and on the given square is a passed pawn:
213 ///      PassedPawnMask[c][s] = pawn_attack_span(c, s) | forward_file_bb(c, s)
214
215 inline Bitboard passed_pawn_mask(Color c, Square s) {
216   return PassedPawnMask[c][s];
217 }
218
219
220 /// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
221 /// straight or on a diagonal line.
222
223 inline bool aligned(Square s1, Square s2, Square s3) {
224   return LineBB[s1][s2] & s3;
225 }
226
227
228 /// distance() functions return the distance between x and y, defined as the
229 /// number of steps for a king in x to reach y. Works with squares, ranks, files.
230
231 template<typename T> inline int distance(T x, T y) { return x < y ? y - x : x - y; }
232 template<> inline int distance<Square>(Square x, Square y) { return SquareDistance[x][y]; }
233
234 template<typename T1, typename T2> inline int distance(T2 x, T2 y);
235 template<> inline int distance<File>(Square x, Square y) { return distance(file_of(x), file_of(y)); }
236 template<> inline int distance<Rank>(Square x, Square y) { return distance(rank_of(x), rank_of(y)); }
237
238
239 /// attacks_bb() returns a bitboard representing all the squares attacked by a
240 /// piece of type Pt (bishop or rook) placed on 's'.
241
242 template<PieceType Pt>
243 inline Bitboard attacks_bb(Square s, Bitboard occupied) {
244
245   const Magic& m = Pt == ROOK ? RookMagics[s] : BishopMagics[s];
246   return m.attacks[m.index(occupied)];
247 }
248
249 inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
250
251   assert(pt != PAWN);
252
253   switch (pt)
254   {
255   case BISHOP: return attacks_bb<BISHOP>(s, occupied);
256   case ROOK  : return attacks_bb<  ROOK>(s, occupied);
257   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
258   default    : return PseudoAttacks[pt][s];
259   }
260 }
261
262
263 /// popcount() counts the number of non-zero bits in a bitboard
264
265 inline int popcount(Bitboard b) {
266
267 #ifndef USE_POPCNT
268
269   extern uint8_t PopCnt16[1 << 16];
270   union { Bitboard bb; uint16_t u[4]; } v = { b };
271   return PopCnt16[v.u[0]] + PopCnt16[v.u[1]] + PopCnt16[v.u[2]] + PopCnt16[v.u[3]];
272
273 #elif defined(_MSC_VER) || defined(__INTEL_COMPILER)
274
275   return (int)_mm_popcnt_u64(b);
276
277 #else // Assumed gcc or compatible compiler
278
279   return __builtin_popcountll(b);
280
281 #endif
282 }
283
284
285 /// lsb() and msb() return the least/most significant bit in a non-zero bitboard
286
287 #if defined(__GNUC__)
288
289 inline Square lsb(Bitboard b) {
290   assert(b);
291   return Square(__builtin_ctzll(b));
292 }
293
294 inline Square msb(Bitboard b) {
295   assert(b);
296   return Square(63 ^ __builtin_clzll(b));
297 }
298
299 #elif defined(_WIN64) && defined(_MSC_VER)
300
301 inline Square lsb(Bitboard b) {
302   assert(b);
303   unsigned long idx;
304   _BitScanForward64(&idx, b);
305   return (Square) idx;
306 }
307
308 inline Square msb(Bitboard b) {
309   assert(b);
310   unsigned long idx;
311   _BitScanReverse64(&idx, b);
312   return (Square) idx;
313 }
314
315 #else
316
317 #define NO_BSF // Fallback on software implementation for other cases
318
319 Square lsb(Bitboard b);
320 Square msb(Bitboard b);
321
322 #endif
323
324
325 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard
326
327 inline Square pop_lsb(Bitboard* b) {
328   const Square s = lsb(*b);
329   *b &= *b - 1;
330   return s;
331 }
332
333
334 /// frontmost_sq() and backmost_sq() return the square corresponding to the
335 /// most/least advanced bit relative to the given color.
336
337 inline Square frontmost_sq(Color c, Bitboard b) { return c == WHITE ? msb(b) : lsb(b); }
338 inline Square  backmost_sq(Color c, Bitboard b) { return c == WHITE ? lsb(b) : msb(b); }
339
340 #endif // #ifndef BITBOARD_H_INCLUDED