b2/core/include/bertini2/endgames/config.hpp

//This file is part of Bertini 2.
//
//include/bertini2/endgames/config.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.
//
//include/bertini2/endgames/config.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 include/bertini2/endgames/config.hpp.  If not, see <http://www.gnu.org/licenses/>.
//
// Copyright(C) 2015-2021 by 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.

// individual authors of this file include:
// silviana amethyst, university of wisconsin eau claire


/**
\file include/bertini2/endgames/config.hpp

\brief Configs and settings for endgames.
*/

#pragma once

#include "bertini2/detail/typelist.hpp"
#include "bertini2/common/config.hpp"


namespace bertini{ namespace endgame{


		// // some forward declarations
// base
	template<class FlavorT, class PrecT>
	class EndgameBase;

// flavors
	template<typename PrecT> 
	class PowerSeriesEndgame;

	template<typename PrecT> 
	class CauchyEndgame;

// precision types
	template<typename TrackerT>
	class FixedPrecEndgame;

	class AMPEndgame;

	// end forward declarations



	/**
	Base empty class
	*/
	template <typename TrackerT>
	struct EGPrecSelector;

	// specialize this in the specific files it goes in, please

	



	/**
	\brief Facilitates lookup of required endgame type based on tracker type
	
	Your current choices are PSEG or Cauchy.

	To get the Power Series Endgame for Adaptive Precision Tracker, use the following example code:
	\code
	using EGT = EndgameSelector<AMPTracker>::PSEG
	\endcode

	\tparam TrackerT The type of tracker you want to use.
	*/
	template<typename TrackerT>
	struct EndgameSelector
	{ 
		using EGPrecT = typename EGPrecSelector<TrackerT>::type;

		using PSEG = endgame::PowerSeriesEndgame<EGPrecT>;
		using Cauchy = endgame::CauchyEndgame<EGPrecT>;
	};

	struct SecurityConfig
	{
		int level = 0; //SecurityLevel
		NumErrorT max_norm = NumErrorT(1e4); //SecurityMaxNorm wrong default value
	};

	
	struct EndgameConfig
	{
		using T = NumErrorT;
		T sample_point_refinement_factor = 1e-2; ///* Extra amount of tolerance for refining before computing the final approximation, during endgame.
		unsigned num_sample_points = 3; //NumSamplePoints default = 2
		T min_track_time = T(1e-100); //nbrh radius in Bertini book. NbhdRadius

		mpq_rational sample_factor = mpq_rational(1,2); //SampleFactor
		
		unsigned max_num_newton_iterations = 15; // the maximum number allowable iterations during endgames, for points used to approximate the final solution.

		T final_tolerance = 1e-11;///< The tolerance to which to compute the endpoint using the endgame.
	};


	struct PowerSeriesConfig
	{
		unsigned max_cycle_number = 6; //MaxCycleNum
		unsigned cycle_number_amplification = 5;
	};

	
	struct CauchyConfig
	{
		using T = NumErrorT;

		T cycle_cutoff_time = T(1)/T(100000000); //CycleTimeCutoff
		T ratio_cutoff_time = T(1)/T(100000000000000); //RatioTimeCutoff
		T minimum_for_c_over_k_stabilization = T(3)/T(4);
		unsigned int num_needed_for_stabilization = 3;
		T maximum_cauchy_ratio = T(1)/T(2);
		unsigned int fail_safe_maximum_cycle_number = 250; //max number of loops before giving up. 

	};


	struct TrackBackConfig
	{
		unsigned minimum_cycle = 4; //MinCycleTrackback, default = 4
		bool junk_removal_test = 1; //JunkRemovalTest, default = 1
		unsigned max_depth_LDT = 3; //MaxLDTDepth, default = 3
	};


	// an empty base class
	template <typename T>
	struct AlgoTraits;

	/**
	specialization for PowerSeries, which uses CRTP
	*/
	template<typename PrecT>
	struct AlgoTraits< PowerSeriesEndgame<PrecT>>
	{
		using NeededConfigs = detail::TypeList<
			PowerSeriesConfig,
			EndgameConfig,
			SecurityConfig
			>;

		using EmitterType = PowerSeriesEndgame<PrecT>;
	};


	/**
	specialization for Cauchy, which uses CRTP
	*/
	template<typename PrecT>
	struct AlgoTraits< CauchyEndgame<PrecT>>
	{
		using NeededConfigs = detail::TypeList<
			CauchyConfig,
			EndgameConfig,
			SecurityConfig>;
	};
	
	


} } // namespaces