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

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2021 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 ENDGAME_H_INCLUDED
  20 #define ENDGAME_H_INCLUDED
  21
  22 #include <memory>
  23 #include <string>
  24 #include <type_traits>
  25 #include <unordered_map>
  26 #include <utility>
  27
  28 #include "position.h"
  29 #include "types.h"
  30
  31 namespace Stockfish {
  32
  33 /// EndgameCode lists all supported endgame functions by corresponding codes
  34
  35 enum EndgameCode {
  36
  37   EVALUATION_FUNCTIONS,
  38   KNNK,  // KNN vs K
  39   KNNKP, // KNN vs KP
  40   KXK,   // Generic "mate lone king" eval
  41   KBNK,  // KBN vs K
  42   KPK,   // KP vs K
  43   KRKP,  // KR vs KP
  44   KRKB,  // KR vs KB
  45   KRKN,  // KR vs KN
  46   KQKP,  // KQ vs KP
  47   KQKR,  // KQ vs KR
  48
  49   SCALING_FUNCTIONS,
  50   KBPsK,   // KB and pawns vs K
  51   KQKRPs,  // KQ vs KR and pawns
  52   KRPKR,   // KRP vs KR
  53   KRPKB,   // KRP vs KB
  54   KRPPKRP, // KRPP vs KRP
  55   KPsK,    // K and pawns vs K
  56   KBPKB,   // KBP vs KB
  57   KBPPKB,  // KBPP vs KB
  58   KBPKN,   // KBP vs KN
  59   KPKP     // KP vs KP
  60 };
  61
  62
  63 /// Endgame functions can be of two types depending on whether they return a
  64 /// Value or a ScaleFactor.
  65
  66 template<EndgameCode E> using
  67 eg_type = typename std::conditional<(E < SCALING_FUNCTIONS), Value, ScaleFactor>::type;
  68
  69
  70 /// Base and derived functors for endgame evaluation and scaling functions
  71
  72 template<typename T>
  73 struct EndgameBase {
  74
  75   explicit EndgameBase(Color c) : strongSide(c), weakSide(~c) {}
  76   virtual ~EndgameBase() = default;
  77   virtual T operator()(const Position&) const = 0;
  78
  79   const Color strongSide, weakSide;
  80 };
  81
  82
  83 template<EndgameCode E, typename T = eg_type<E>>
  84 struct Endgame : public EndgameBase<T> {
  85
  86   explicit Endgame(Color c) : EndgameBase<T>(c) {}
  87   T operator()(const Position&) const override;
  88 };
  89
  90
  91 /// The Endgames namespace handles the pointers to endgame evaluation and scaling
  92 /// base objects in two std::map. We use polymorphism to invoke the actual
  93 /// endgame function by calling its virtual operator().
  94
  95 namespace Endgames {
  96
  97   template<typename T> using Ptr = std::unique_ptr<EndgameBase<T>>;
  98   template<typename T> using Map = std::unordered_map<Key, Ptr<T>>;
  99
 100   extern std::pair<Map<Value>, Map<ScaleFactor>> maps;
 101
 102   void init();
 103
 104   template<typename T>
 105   Map<T>& map() {
 106     return std::get<std::is_same<T, ScaleFactor>::value>(maps);
 107   }
 108
 109   template<EndgameCode E, typename T = eg_type<E>>
 110   void add(const std::string& code) {
 111
 112     StateInfo st;
 113     map<T>()[Position().set(code, WHITE, &st).material_key()] = Ptr<T>(new Endgame<E>(WHITE));
 114     map<T>()[Position().set(code, BLACK, &st).material_key()] = Ptr<T>(new Endgame<E>(BLACK));
 115   }
 116
 117   template<typename T>
 118   const EndgameBase<T>* probe(Key key) {
 119     auto it = map<T>().find(key);
 120     return it != map<T>().end() ? it->second.get() : nullptr;
 121   }
 122 }
 123
 124 } // namespace Stockfish
 125
 126 #endif // #ifndef ENDGAME_H_INCLUDED