config_encoding.hpp

Go to the documentation of this file.

//This file is part of Bertini 2.
//
//config_encoding.hpp is free software: you can redistribute it and/or modify
//it under the terms of the GNU General Public License as published by
//the Free Software Foundation, either version 3 of the License, or
//(at your option) any later version.
//
//config_encoding.hpp is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU General Public License for more details.
//
//You should have received a copy of the GNU General Public License
//along with config_encoding.hpp.  If not, see <http://www.gnu.org/licenses/>.
//
// Copyright(C) Bertini2 Development Team
//
// See <http://www.gnu.org/licenses/> for a copy of the license,
// as well as COPYING.  Bertini2 is provided with permitted
// additional terms in the b2/licenses/ directory.

 
#pragma once
 
#include <string>
 
#include "bertini2/detail/sha256.hpp"
#include "bertini2/trackers/config.hpp"
#include "bertini2/endgames/config.hpp"
#include "bertini2/nag_algorithms/common/config.hpp"
 
namespace bertini {
namespace records {

constexpr char ConfigEncodingVersion[] = "b2cfgenc/4";

std::string CanonicalName(tracking::Predictor p);
std::string CanonicalName(algorithm::classic::AlgoChoice a);
std::string CanonicalName(algorithm::classic::EndgameChoice e);

std::string CanonicalEncoding(tracking::SteppingConfig const& c);
std::string CanonicalEncoding(tracking::NewtonConfig const& c);
std::string CanonicalEncoding(tracking::FixedPrecisionConfig const& c);
std::string CanonicalEncoding(tracking::AdaptiveMultiplePrecisionConfig const& c);
std::string CanonicalEncoding(tracking::Predictor p);

std::string CanonicalEncoding(tracking::TrackerConfig const& c);

std::string CanonicalEncoding(endgame::SecurityConfig const& c);
std::string CanonicalEncoding(endgame::EndgameConfig const& c);
std::string CanonicalEncoding(endgame::PowerSeriesConfig const& c);
std::string CanonicalEncoding(endgame::CauchyConfig const& c);
std::string CanonicalEncoding(endgame::TrackBackConfig const& c);

std::string CanonicalEncoding(algorithm::TolerancesConfig const& c);
std::string CanonicalEncoding(algorithm::MidPathConfig const& c);
std::string CanonicalEncoding(algorithm::AutoRetrackConfig const& c);
std::string CanonicalEncoding(algorithm::SharpeningConfig const& c);
std::string CanonicalEncoding(algorithm::RegenerationConfig const& c);
std::string CanonicalEncoding(algorithm::PostProcessingConfig const& c);
std::string CanonicalEncoding(algorithm::ZeroDimConfig const& c);
std::string CanonicalEncoding(algorithm::MetaConfig const& c);
std::string CanonicalEncoding(algorithm::classic::EndgameChoiceConfig const& c);

template <typename ConfigT>
detail::Digest256 ConfigDigest(ConfigT const& config)
{
    return detail::Sha256(std::string(ConfigEncodingVersion) + "\n" + CanonicalEncoding(config));
}

template <typename... ConfigTs>
detail::Digest256 SettingsDigest(ConfigTs const&... configs)
{
    std::string combined(ConfigEncodingVersion);
    ((combined += "\n" + CanonicalEncoding(configs)), ...);
    return detail::Sha256(combined);
}

std::string ConfigTextAsJson(std::string const& canonical_text, std::string const& digest_hex);
 
} // namespace records
} // namespace bertini