predict.hpp File Reference

Wrapper functions for calling ODE predictors for systems. More...

#include "bertini2/trackers/ode_predictors.hpp"

Include dependency graph for predict.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
template<typename ComplexT, typename TolT>
SuccessCode	bertini::tracking::Predict (Predictor predictor_choice, Vec< ComplexT > &next_space, System const &sys, Vec< ComplexT > const &current_space, ComplexT const &current_time, ComplexT const &delta_t, TolT &condition_number_estimate, unsigned &num_steps_since_last_condition_number_computation, unsigned frequency_of_CN_estimation, TolT const &tracking_tolerance)
template<typename ComplexT, typename TolT>
SuccessCode	bertini::tracking::Predict (Predictor predictor_choice, Vec< ComplexT > &next_space, System const &sys, Vec< ComplexT > const &current_space, ComplexT current_time, ComplexT const &delta_t, TolT &condition_number_estimate, unsigned &num_steps_since_last_condition_number_computation, unsigned frequency_of_CN_estimation, TolT const &tracking_tolerance, AdaptiveMultiplePrecisionConfig const &AMP_config)
template<typename ComplexT, typename TolT>
SuccessCode	bertini::tracking::Predict (Predictor predictor_choice, Vec< ComplexT > &next_space, TolT &error_estimate, TolT &size_proportion, TolT &norm_J, TolT &norm_J_inverse, System const &sys, Vec< ComplexT > const &current_space, ComplexT current_time, ComplexT const &delta_t, TolT &condition_number_estimate, unsigned &num_steps_since_last_condition_number_computation, unsigned frequency_of_CN_estimation, TolT const &tracking_tolerance, AdaptiveMultiplePrecisionConfig const &AMP_config)
template<typename ComplexT, typename TolT>
SuccessCode	bertini::tracking::Predict (Predictor predictor_choice, Vec< ComplexT > &next_space, TolT &size_proportion, TolT &norm_J, TolT &norm_J_inverse, System const &sys, Vec< ComplexT > const &current_space, ComplexT current_time, ComplexT const &delta_t, TolT &condition_number_estimate, unsigned &num_steps_since_last_condition_number_computation, unsigned frequency_of_CN_estimation, TolT const &tracking_tolerance, AdaptiveMultiplePrecisionConfig const &AMP_config)

Detailed Description

Wrapper functions for calling ODE predictors for systems.

Function Documentation

Predict() [1/4]

template<typename ComplexT, typename TolT>

SuccessCode bertini::tracking::Predict	(	Predictor	predictor_choice,
		Vec< ComplexT > &	next_space,
		System const &	sys,
		Vec< ComplexT > const &	current_space,
		ComplexT const &	current_time,
		ComplexT const &	delta_t,
		TolT &	condition_number_estimate,
		unsigned &	num_steps_since_last_condition_number_computation,
		unsigned	frequency_of_CN_estimation,
		TolT const &	tracking_tolerance )

Wrapper class for calling an ODE predictor, using fixed precision

Parameters

predictor_choice	The enum class selecting the predictor to be used.
next_space	The computed prediction.
sys	The system being solved.
current_space	The current space variable vector.
current_time	The current time.
delta_t	The size of the time step.
condition_number_estimate	The computed estimate of the condition number of the Jacobian.
num_steps_since_last_condition_number_computation.	Updated in this function.
frequency_of_CN_estimation	How many steps to take between condition number estimates.
prec_type	The operating precision type.
tracking_tolerance	How tightly to track the path.
AMP_config	The settings for adaptive multiple precision.

Template Parameters

ComplexT	The complex number type for evaluation.
TolT	The numeric type for tolerances and state.

Here is the call graph for this function:

Predict() [2/4]

template<typename ComplexT, typename TolT>

SuccessCode bertini::tracking::Predict	(	Predictor	predictor_choice,
		Vec< ComplexT > &	next_space,
		System const &	sys,
		Vec< ComplexT > const &	current_space,
		ComplexT	current_time,
		ComplexT const &	delta_t,
		TolT &	condition_number_estimate,
		unsigned &	num_steps_since_last_condition_number_computation,
		unsigned	frequency_of_CN_estimation,
		TolT const &	tracking_tolerance,
		AdaptiveMultiplePrecisionConfig const &	AMP_config )

Wrapper class for calling an ODE predictor, using adaptive precision, not returning some meta-data about the step.

Parameters

predictor_choice	The enum class selecting the predictor to be used.
next_space	The computed prediction.
sys	The system being solved.
current_space	The current space variable vector.
current_time	The current time.
delta_t	The size of the time step.
condition_number_estimate	The computed estimate of the condition number of the Jacobian.
num_steps_since_last_condition_number_computation.	Updated in this function.
frequency_of_CN_estimation	How many steps to take between condition number estimates.
prec_type	The operating precision type.
tracking_tolerance	How tightly to track the path.
AMP_config	The settings for adaptive multiple precision.

Template Parameters

ComplexT	The complex number type for evaluation.
TolT	The complex number type for evaluation.

Predict() [3/4]

template<typename ComplexT, typename TolT>

SuccessCode bertini::tracking::Predict	(	Predictor	predictor_choice,
		Vec< ComplexT > &	next_space,
		TolT &	error_estimate,
		TolT &	size_proportion,
		TolT &	norm_J,
		TolT &	norm_J_inverse,
		System const &	sys,
		Vec< ComplexT > const &	current_space,
		ComplexT	current_time,
		ComplexT const &	delta_t,
		TolT &	condition_number_estimate,
		unsigned &	num_steps_since_last_condition_number_computation,
		unsigned	frequency_of_CN_estimation,
		TolT const &	tracking_tolerance,
		AdaptiveMultiplePrecisionConfig const &	AMP_config )

An overload of Predict which returns (by reference) error estimate, and estimates of the norm of \(J\) and \(J^{-1}\), and the size proportion \(a\) from AMP2 paper [2].

See also

Predict

Here is the call graph for this function:

Predict() [4/4]

template<typename ComplexT, typename TolT>

SuccessCode bertini::tracking::Predict	(	Predictor	predictor_choice,
		Vec< ComplexT > &	next_space,
		TolT &	size_proportion,
		TolT &	norm_J,
		TolT &	norm_J_inverse,
		System const &	sys,
		Vec< ComplexT > const &	current_space,
		ComplexT	current_time,
		ComplexT const &	delta_t,
		TolT &	condition_number_estimate,
		unsigned &	num_steps_since_last_condition_number_computation,
		unsigned	frequency_of_CN_estimation,
		TolT const &	tracking_tolerance,
		AdaptiveMultiplePrecisionConfig const &	AMP_config )

An overload of Predict which returns (by reference) error estimate, and estimates of the norm of \(J\) and \(J^{-1}\) from AMP2 paper [2].

See also

Predict

Here is the call graph for this function: