git.sesse.net Git - stockfish/blob - src/nnue/evaluate_nnue.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 // header used in NNUE evaluation function
  20
  21 #ifndef NNUE_EVALUATE_NNUE_H_INCLUDED
  22 #define NNUE_EVALUATE_NNUE_H_INCLUDED
  23
  24 #include <cstdint>
  25 #include <iosfwd>
  26 #include <memory>
  27 #include <optional>
  28 #include <string>
  29
  30 #include "../misc.h"
  31 #include "nnue_architecture.h"
  32 #include "nnue_feature_transformer.h"
  33
  34 namespace Stockfish {
  35 class Position;
  36 enum Value : int;
  37 }
  38
  39 namespace Stockfish::Eval::NNUE {
  40
  41 // Hash value of evaluation function structure
  42 constexpr std::uint32_t HashValue =
  43   FeatureTransformer::get_hash_value() ^ Network::get_hash_value();
  44
  45
  46 // Deleter for automating release of memory area
  47 template<typename T>
  48 struct AlignedDeleter {
  49     void operator()(T* ptr) const {
  50         ptr->~T();
  51         std_aligned_free(ptr);
  52     }
  53 };
  54
  55 template<typename T>
  56 struct LargePageDeleter {
  57     void operator()(T* ptr) const {
  58         ptr->~T();
  59         aligned_large_pages_free(ptr);
  60     }
  61 };
  62
  63 template<typename T>
  64 using AlignedPtr = std::unique_ptr<T, AlignedDeleter<T>>;
  65
  66 template<typename T>
  67 using LargePagePtr = std::unique_ptr<T, LargePageDeleter<T>>;
  68
  69 std::string trace(Position& pos);
  70 Value       evaluate(const Position& pos, bool adjusted = false, int* complexity = nullptr);
  71 void        hint_common_parent_position(const Position& pos);
  72
  73 bool load_eval(std::string name, std::istream& stream);
  74 bool save_eval(std::ostream& stream);
  75 bool save_eval(const std::optional<std::string>& filename);
  76
  77 }  // namespace Stockfish::Eval::NNUE
  78
  79 #endif  // #ifndef NNUE_EVALUATE_NNUE_H_INCLUDED