git.sesse.net Git - stockfish/blob - src/movepick.h

   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 #ifndef MOVEPICK_H_INCLUDED
  20 #define MOVEPICK_H_INCLUDED
  21
  22 #include <array>
  23 #include <cassert>
  24 #include <cstdint>
  25 #include <cstdlib>
  26 #include <limits>
  27 #include <type_traits> // IWYU pragma: keep
  28
  29 #include "movegen.h"
  30 #include "types.h"
  31
  32 namespace Stockfish {
  33 class Position;
  34
  35 // StatsEntry stores the stat table value. It is usually a number but could
  36 // be a move or even a nested history. We use a class instead of a naked value
  37 // to directly call history update operator<<() on the entry so to use stats
  38 // tables at caller sites as simple multi-dim arrays.
  39 template<typename T, int D>
  40 class StatsEntry {
  41
  42   T entry;
  43
  44 public:
  45   void operator=(const T& v) { entry = v; }
  46   T* operator&() { return &entry; }
  47   T* operator->() { return &entry; }
  48   operator const T&() const { return entry; }
  49
  50   void operator<<(int bonus) {
  51     assert(abs(bonus) <= D); // Ensure range is [-D, D]
  52     static_assert(D <= std::numeric_limits<T>::max(), "D overflows T");
  53
  54     entry += (bonus * D - entry * abs(bonus)) / (D * 5 / 4);
  55
  56     assert(abs(entry) <= D);
  57   }
  58 };
  59
  60 // Stats is a generic N-dimensional array used to store various statistics.
  61 // The first template parameter T is the base type of the array, and the second
  62 // template parameter D limits the range of updates in [-D, D] when we update
  63 // values with the << operator, while the last parameters (Size and Sizes)
  64 // encode the dimensions of the array.
  65 template <typename T, int D, int Size, int... Sizes>
  66 struct Stats : public std::array<Stats<T, D, Sizes...>, Size>
  67 {
  68   using stats = Stats<T, D, Size, Sizes...>;
  69
  70   void fill(const T& v) {
  71
  72     // For standard-layout 'this' points to the first struct member
  73     assert(std::is_standard_layout_v<stats>);
  74
  75     using entry = StatsEntry<T, D>;
  76     entry* p = reinterpret_cast<entry*>(this);
  77     std::fill(p, p + sizeof(*this) / sizeof(entry), v);
  78   }
  79 };
  80
  81 template <typename T, int D, int Size>
  82 struct Stats<T, D, Size> : public std::array<StatsEntry<T, D>, Size> {};
  83
  84 // In stats table, D=0 means that the template parameter is not used
  85 enum StatsParams { NOT_USED = 0 };
  86 enum StatsType { NoCaptures, Captures };
  87
  88 // ButterflyHistory records how often quiet moves have been successful or
  89 // unsuccessful during the current search, and is used for reduction and move
  90 // ordering decisions. It uses 2 tables (one for each color) indexed by
  91 // the move's from and to squares, see www.chessprogramming.org/Butterfly_Boards
  92 // (~11 elo)
  93 using ButterflyHistory = Stats<int16_t, 7183, COLOR_NB, int(SQUARE_NB) * int(SQUARE_NB)>;
  94
  95 // CounterMoveHistory stores counter moves indexed by [piece][to] of the previous
  96 // move, see www.chessprogramming.org/Countermove_Heuristic
  97 using CounterMoveHistory = Stats<Move, NOT_USED, PIECE_NB, SQUARE_NB>;
  98
  99 // CapturePieceToHistory is addressed by a move's [piece][to][captured piece type]
 100 using CapturePieceToHistory = Stats<int16_t, 10692, PIECE_NB, SQUARE_NB, PIECE_TYPE_NB>;
 101
 102 // PieceToHistory is like ButterflyHistory but is addressed by a move's [piece][to]
 103 using PieceToHistory = Stats<int16_t, 29952, PIECE_NB, SQUARE_NB>;
 104
 105 // ContinuationHistory is the combined history of a given pair of moves, usually
 106 // the current one given a previous one. The nested history table is based on
 107 // PieceToHistory instead of ButterflyBoards.
 108 // (~63 elo)
 109 using ContinuationHistory = Stats<PieceToHistory, NOT_USED, PIECE_NB, SQUARE_NB>;
 110
 111
 112 // MovePicker class is used to pick one pseudo-legal move at a time from the
 113 // current position. The most important method is next_move(), which returns a
 114 // new pseudo-legal move each time it is called, until there are no moves left,
 115 // when MOVE_NONE is returned. In order to improve the efficiency of the
 116 // alpha-beta algorithm, MovePicker attempts to return the moves which are most
 117 // likely to get a cut-off first.
 118 class MovePicker {
 119
 120   enum PickType { Next, Best };
 121
 122 public:
 123   MovePicker(const MovePicker&) = delete;
 124   MovePicker& operator=(const MovePicker&) = delete;
 125   MovePicker(const Position&, Move, Depth, const ButterflyHistory*,
 126                                            const CapturePieceToHistory*,
 127                                            const PieceToHistory**,
 128                                            Move,
 129                                            const Move*);
 130   MovePicker(const Position&, Move, Depth, const ButterflyHistory*,
 131                                            const CapturePieceToHistory*,
 132                                            const PieceToHistory**,
 133                                            Square);
 134   MovePicker(const Position&, Move, Value, const CapturePieceToHistory*);
 135   Move next_move(bool skipQuiets = false);
 136
 137 private:
 138   template<PickType T, typename Pred> Move select(Pred);
 139   template<GenType> void score();
 140   ExtMove* begin() { return cur; }
 141   ExtMove* end() { return endMoves; }
 142
 143   const Position& pos;
 144   const ButterflyHistory* mainHistory;
 145   const CapturePieceToHistory* captureHistory;
 146   const PieceToHistory** continuationHistory;
 147   Move ttMove;
 148   ExtMove refutations[3], *cur, *endMoves, *endBadCaptures;
 149   int stage;
 150   Square recaptureSquare;
 151   Value threshold;
 152   Depth depth;
 153   ExtMove moves[MAX_MOVES];
 154 };
 155
 156 } // namespace Stockfish
 157
 158 #endif // #ifndef MOVEPICK_H_INCLUDED