]> git.sesse.net Git - stockfish/blob - src/bitboard.cpp
Reformat some comments
[stockfish] / src / bitboard.cpp
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
4
5   Stockfish is free software: you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9
10   Stockfish is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU General Public License for more details.
14
15   You should have received a copy of the GNU General Public License
16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 #include "bitboard.h"
20
21 #include <algorithm>
22 #include <bitset>
23 #include <initializer_list>
24
25 #include "misc.h"
26
27 namespace Stockfish {
28
29 uint8_t PopCnt16[1 << 16];
30 uint8_t SquareDistance[SQUARE_NB][SQUARE_NB];
31
32 Bitboard LineBB[SQUARE_NB][SQUARE_NB];
33 Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
34 Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
35 Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
36
37 Magic RookMagics[SQUARE_NB];
38 Magic BishopMagics[SQUARE_NB];
39
40 namespace {
41
42 Bitboard RookTable[0x19000];   // To store rook attacks
43 Bitboard BishopTable[0x1480];  // To store bishop attacks
44
45 void init_magics(PieceType pt, Bitboard table[], Magic magics[]);
46
47 }
48
49 // Returns the bitboard of target square for the given step
50 // from the given square. If the step is off the board, returns empty bitboard.
51 inline Bitboard safe_destination(Square s, int step) {
52     Square to = Square(s + step);
53     return is_ok(to) && distance(s, to) <= 2 ? square_bb(to) : Bitboard(0);
54 }
55
56
57 // Returns an ASCII representation of a bitboard suitable
58 // to be printed to standard output. Useful for debugging.
59 std::string Bitboards::pretty(Bitboard b) {
60
61     std::string s = "+---+---+---+---+---+---+---+---+\n";
62
63     for (Rank r = RANK_8; r >= RANK_1; --r)
64     {
65         for (File f = FILE_A; f <= FILE_H; ++f)
66             s += b & make_square(f, r) ? "| X " : "|   ";
67
68         s += "| " + std::to_string(1 + r) + "\n+---+---+---+---+---+---+---+---+\n";
69     }
70     s += "  a   b   c   d   e   f   g   h\n";
71
72     return s;
73 }
74
75
76 // Initializes various bitboard tables. It is called at
77 // startup and relies on global objects to be already zero-initialized.
78 void Bitboards::init() {
79
80     for (unsigned i = 0; i < (1 << 16); ++i)
81         PopCnt16[i] = uint8_t(std::bitset<16>(i).count());
82
83     for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
84         for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
85             SquareDistance[s1][s2] = std::max(distance<File>(s1, s2), distance<Rank>(s1, s2));
86
87     init_magics(ROOK, RookTable, RookMagics);
88     init_magics(BISHOP, BishopTable, BishopMagics);
89
90     for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
91     {
92         PawnAttacks[WHITE][s1] = pawn_attacks_bb<WHITE>(square_bb(s1));
93         PawnAttacks[BLACK][s1] = pawn_attacks_bb<BLACK>(square_bb(s1));
94
95         for (int step : {-9, -8, -7, -1, 1, 7, 8, 9})
96             PseudoAttacks[KING][s1] |= safe_destination(s1, step);
97
98         for (int step : {-17, -15, -10, -6, 6, 10, 15, 17})
99             PseudoAttacks[KNIGHT][s1] |= safe_destination(s1, step);
100
101         PseudoAttacks[QUEEN][s1] = PseudoAttacks[BISHOP][s1] = attacks_bb<BISHOP>(s1, 0);
102         PseudoAttacks[QUEEN][s1] |= PseudoAttacks[ROOK][s1]  = attacks_bb<ROOK>(s1, 0);
103
104         for (PieceType pt : {BISHOP, ROOK})
105             for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
106             {
107                 if (PseudoAttacks[pt][s1] & s2)
108                 {
109                     LineBB[s1][s2] = (attacks_bb(pt, s1, 0) & attacks_bb(pt, s2, 0)) | s1 | s2;
110                     BetweenBB[s1][s2] =
111                       (attacks_bb(pt, s1, square_bb(s2)) & attacks_bb(pt, s2, square_bb(s1)));
112                 }
113                 BetweenBB[s1][s2] |= s2;
114             }
115     }
116 }
117
118 namespace {
119
120 Bitboard sliding_attack(PieceType pt, Square sq, Bitboard occupied) {
121
122     Bitboard  attacks             = 0;
123     Direction RookDirections[4]   = {NORTH, SOUTH, EAST, WEST};
124     Direction BishopDirections[4] = {NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST};
125
126     for (Direction d : (pt == ROOK ? RookDirections : BishopDirections))
127     {
128         Square s = sq;
129         while (safe_destination(s, d) && !(occupied & s))
130             attacks |= (s += d);
131     }
132
133     return attacks;
134 }
135
136
137 // Computes all rook and bishop attacks at startup. Magic
138 // bitboards are used to look up attacks of sliding pieces. As a reference see
139 // www.chessprogramming.org/Magic_Bitboards. In particular, here we use the so
140 // called "fancy" approach.
141 void init_magics(PieceType pt, Bitboard table[], Magic magics[]) {
142
143     // Optimal PRNG seeds to pick the correct magics in the shortest time
144     int seeds[][RANK_NB] = {{8977, 44560, 54343, 38998, 5731, 95205, 104912, 17020},
145                             {728, 10316, 55013, 32803, 12281, 15100, 16645, 255}};
146
147     Bitboard occupancy[4096], reference[4096], edges, b;
148     int      epoch[4096] = {}, cnt = 0, size = 0;
149
150     for (Square s = SQ_A1; s <= SQ_H8; ++s)
151     {
152         // Board edges are not considered in the relevant occupancies
153         edges = ((Rank1BB | Rank8BB) & ~rank_bb(s)) | ((FileABB | FileHBB) & ~file_bb(s));
154
155         // Given a square 's', the mask is the bitboard of sliding attacks from
156         // 's' computed on an empty board. The index must be big enough to contain
157         // all the attacks for each possible subset of the mask and so is 2 power
158         // the number of 1s of the mask. Hence we deduce the size of the shift to
159         // apply to the 64 or 32 bits word to get the index.
160         Magic& m = magics[s];
161         m.mask   = sliding_attack(pt, s, 0) & ~edges;
162         m.shift  = (Is64Bit ? 64 : 32) - popcount(m.mask);
163
164         // Set the offset for the attacks table of the square. We have individual
165         // table sizes for each square with "Fancy Magic Bitboards".
166         m.attacks = s == SQ_A1 ? table : magics[s - 1].attacks + size;
167
168         // Use Carry-Rippler trick to enumerate all subsets of masks[s] and
169         // store the corresponding sliding attack bitboard in reference[].
170         b = size = 0;
171         do
172         {
173             occupancy[size] = b;
174             reference[size] = sliding_attack(pt, s, b);
175
176             if (HasPext)
177                 m.attacks[pext(b, m.mask)] = reference[size];
178
179             size++;
180             b = (b - m.mask) & m.mask;
181         } while (b);
182
183         if (HasPext)
184             continue;
185
186         PRNG rng(seeds[Is64Bit][rank_of(s)]);
187
188         // Find a magic for square 's' picking up an (almost) random number
189         // until we find the one that passes the verification test.
190         for (int i = 0; i < size;)
191         {
192             for (m.magic = 0; popcount((m.magic * m.mask) >> 56) < 6;)
193                 m.magic = rng.sparse_rand<Bitboard>();
194
195             // A good magic must map every possible occupancy to an index that
196             // looks up the correct sliding attack in the attacks[s] database.
197             // Note that we build up the database for square 's' as a side
198             // effect of verifying the magic. Keep track of the attempt count
199             // and save it in epoch[], little speed-up trick to avoid resetting
200             // m.attacks[] after every failed attempt.
201             for (++cnt, i = 0; i < size; ++i)
202             {
203                 unsigned idx = m.index(occupancy[i]);
204
205                 if (epoch[idx] < cnt)
206                 {
207                     epoch[idx]     = cnt;
208                     m.attacks[idx] = reference[i];
209                 }
210                 else if (m.attacks[idx] != reference[i])
211                     break;
212             }
213         }
214     }
215 }
216 }
217
218 }  // namespace Stockfish