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