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