Assorted trivial cleanups 3/2019 (#2030)
[stockfish] / src / bitboard.cpp
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-2019 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 #include <bitset>
22 #include <algorithm>
23
24 #include "bitboard.h"
25 #include "misc.h"
26
27 uint8_t PopCnt16[1 << 16];
28 uint8_t SquareDistance[SQUARE_NB][SQUARE_NB];
29
30 Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
31 Bitboard LineBB[SQUARE_NB][SQUARE_NB];
32 Bitboard DistanceRingBB[SQUARE_NB][8];
33 Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
34 Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
35 Bitboard SquareBB[SQUARE_NB];
36
37 Bitboard KingFlank[FILE_NB] = {
38   QueenSide ^ FileDBB, QueenSide, QueenSide,
39   CenterFiles, CenterFiles,
40   KingSide, KingSide, KingSide ^ FileEBB
41 };
42
43 Magic RookMagics[SQUARE_NB];
44 Magic BishopMagics[SQUARE_NB];
45
46 namespace {
47
48   Bitboard RookTable[0x19000];  // To store rook attacks
49   Bitboard BishopTable[0x1480]; // To store bishop attacks
50
51   void init_magics(Bitboard table[], Magic magics[], Direction directions[]);
52 }
53
54
55 /// Bitboards::pretty() returns an ASCII representation of a bitboard suitable
56 /// to be printed to standard output. Useful for debugging.
57
58 const std::string Bitboards::pretty(Bitboard b) {
59
60   std::string s = "+---+---+---+---+---+---+---+---+\n";
61
62   for (Rank r = RANK_8; r >= RANK_1; --r)
63   {
64       for (File f = FILE_A; f <= FILE_H; ++f)
65           s += b & make_square(f, r) ? "| X " : "|   ";
66
67       s += "|\n+---+---+---+---+---+---+---+---+\n";
68   }
69
70   return s;
71 }
72
73
74 /// Bitboards::init() initializes various bitboard tables. It is called at
75 /// startup and relies on global objects to be already zero-initialized.
76
77 void Bitboards::init() {
78
79   for (unsigned i = 0; i < (1 << 16); ++i)
80       PopCnt16[i] = std::bitset<16>(i).count();
81
82   for (Square s = SQ_A1; s <= SQ_H8; ++s)
83       SquareBB[s] = (1ULL << s);
84
85   for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
86       for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
87           {
88               SquareDistance[s1][s2] = std::max(distance<File>(s1, s2), distance<Rank>(s1, s2));
89               DistanceRingBB[s1][SquareDistance[s1][s2]] |= s2;
90           }
91
92   int steps[][5] = { {}, { 7, 9 }, { 6, 10, 15, 17 }, {}, {}, {}, { 1, 7, 8, 9 } };
93
94   for (Color c = WHITE; c <= BLACK; ++c)
95       for (PieceType pt : { PAWN, KNIGHT, KING })
96           for (Square s = SQ_A1; s <= SQ_H8; ++s)
97               for (int i = 0; steps[pt][i]; ++i)
98               {
99                   Square to = s + Direction(c == WHITE ? steps[pt][i] : -steps[pt][i]);
100
101                   if (is_ok(to) && distance(s, to) < 3)
102                   {
103                       if (pt == PAWN)
104                           PawnAttacks[c][s] |= to;
105                       else
106                           PseudoAttacks[pt][s] |= to;
107                   }
108               }
109
110   Direction RookDirections[] = { NORTH, EAST, SOUTH, WEST };
111   Direction BishopDirections[] = { NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST };
112
113   init_magics(RookTable, RookMagics, RookDirections);
114   init_magics(BishopTable, BishopMagics, BishopDirections);
115
116   for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
117   {
118       PseudoAttacks[QUEEN][s1]  = PseudoAttacks[BISHOP][s1] = attacks_bb<BISHOP>(s1, 0);
119       PseudoAttacks[QUEEN][s1] |= PseudoAttacks[  ROOK][s1] = attacks_bb<  ROOK>(s1, 0);
120
121       for (PieceType pt : { BISHOP, ROOK })
122           for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
123               if (PseudoAttacks[pt][s1] & s2)
124               {
125                   LineBB[s1][s2] = (attacks_bb(pt, s1, 0) & attacks_bb(pt, s2, 0)) | s1 | s2;
126                   BetweenBB[s1][s2] = attacks_bb(pt, s1, square_bb(s2)) & attacks_bb(pt, s2, square_bb(s1));
127               }
128   }
129 }
130
131
132 namespace {
133
134   Bitboard sliding_attack(Direction directions[], Square sq, Bitboard occupied) {
135
136     Bitboard attack = 0;
137
138     for (int i = 0; i < 4; ++i)
139         for (Square s = sq + directions[i];
140              is_ok(s) && distance(s, s - directions[i]) == 1;
141              s += directions[i])
142         {
143             attack |= s;
144
145             if (occupied & s)
146                 break;
147         }
148
149     return attack;
150   }
151
152
153   // init_magics() computes all rook and bishop attacks at startup. Magic
154   // bitboards are used to look up attacks of sliding pieces. As a reference see
155   // www.chessprogramming.org/Magic_Bitboards. In particular, here we use the so
156   // called "fancy" approach.
157
158   void init_magics(Bitboard table[], Magic magics[], Direction directions[]) {
159
160     // Optimal PRNG seeds to pick the correct magics in the shortest time
161     int seeds[][RANK_NB] = { { 8977, 44560, 54343, 38998,  5731, 95205, 104912, 17020 },
162                              {  728, 10316, 55013, 32803, 12281, 15100,  16645,   255 } };
163
164     Bitboard occupancy[4096], reference[4096], edges, b;
165     int epoch[4096] = {}, cnt = 0, size = 0;
166
167     for (Square s = SQ_A1; s <= SQ_H8; ++s)
168     {
169         // Board edges are not considered in the relevant occupancies
170         edges = ((Rank1BB | Rank8BB) & ~rank_bb(s)) | ((FileABB | FileHBB) & ~file_bb(s));
171
172         // Given a square 's', the mask is the bitboard of sliding attacks from
173         // 's' computed on an empty board. The index must be big enough to contain
174         // all the attacks for each possible subset of the mask and so is 2 power
175         // the number of 1s of the mask. Hence we deduce the size of the shift to
176         // apply to the 64 or 32 bits word to get the index.
177         Magic& m = magics[s];
178         m.mask  = sliding_attack(directions, s, 0) & ~edges;
179         m.shift = (Is64Bit ? 64 : 32) - popcount(m.mask);
180
181         // Set the offset for the attacks table of the square. We have individual
182         // table sizes for each square with "Fancy Magic Bitboards".
183         m.attacks = s == SQ_A1 ? table : magics[s - 1].attacks + size;
184
185         // Use Carry-Rippler trick to enumerate all subsets of masks[s] and
186         // store the corresponding sliding attack bitboard in reference[].
187         b = size = 0;
188         do {
189             occupancy[size] = b;
190             reference[size] = sliding_attack(directions, s, b);
191
192             if (HasPext)
193                 m.attacks[pext(b, m.mask)] = reference[size];
194
195             size++;
196             b = (b - m.mask) & m.mask;
197         } while (b);
198
199         if (HasPext)
200             continue;
201
202         PRNG rng(seeds[Is64Bit][rank_of(s)]);
203
204         // Find a magic for square 's' picking up an (almost) random number
205         // until we find the one that passes the verification test.
206         for (int i = 0; i < size; )
207         {
208             for (m.magic = 0; popcount((m.magic * m.mask) >> 56) < 6; )
209                 m.magic = rng.sparse_rand<Bitboard>();
210
211             // A good magic must map every possible occupancy to an index that
212             // looks up the correct sliding attack in the attacks[s] database.
213             // Note that we build up the database for square 's' as a side
214             // effect of verifying the magic. Keep track of the attempt count
215             // and save it in epoch[], little speed-up trick to avoid resetting
216             // m.attacks[] after every failed attempt.
217             for (++cnt, i = 0; i < size; ++i)
218             {
219                 unsigned idx = m.index(occupancy[i]);
220
221                 if (epoch[idx] < cnt)
222                 {
223                     epoch[idx] = cnt;
224                     m.attacks[idx] = reference[i];
225                 }
226                 else if (m.attacks[idx] != reference[i])
227                     break;
228             }
229         }
230     }
231   }
232 }