base_predictor.hpp File Reference

Contains a base class for all ODE predictors. More...

#include "bertini2/trackers/amp_criteria.hpp"
#include "bertini2/trackers/config.hpp"
#include "system.hpp"
#include "mpfr_extensions.hpp"
#include <Eigen/LU>
#include <boost/type_index.hpp>

Include dependency graph for base_predictor.hpp:

Go to the source code of this file.

Classes
class	bertini::tracking::predict::BasePredictor
	An interface for all predictors. More...

Functions
Predictor	bertini::tracking::predict::DefaultPredictor ()
	Get the Bertini2 default predictor.
bool	bertini::tracking::predict::HasErrorEstimate (Predictor predictor_choice)
	Ask whether a predictor method provides an error estimate.
unsigned	bertini::tracking::predict::Order (Predictor predictor_choice)
	The order of the predictor.

Detailed Description

Contains a base class for all ODE predictors.

Function Documentation

DefaultPredictor()

Predictor bertini::tracking::predict::DefaultPredictor ( )

inline

Get the Bertini2 default predictor.

Currently set to Euler, though this will change in future versions.

Currently set to RKF45.

Returns

The default predictor method to use.

HasErrorEstimate()

bool bertini::tracking::predict::HasErrorEstimate ( Predictor predictor_choice )

inline

Ask whether a predictor method provides an error estimate.

Returns

Yes or no, does it or does it not.

Parameters

predictor_choice

The predictor method to query.

Order()

unsigned bertini::tracking::predict::Order ( Predictor predictor_choice )

inline

The order of the predictor.

The lowest order of the predictor. The order of the error estimate is this plus one.

The order of the error estimate is this plus one.

Returns

The order of the predictor method.

Parameters

predictor_choice

The predictor method to query.