Base class for algorithmic parameters. More...

#include <algorithm_base.hh>

Detailed Description

Base class for algorithmic parameters.

Definition at line 129 of file algorithm_base.hh.

Inheritance diagram for Kaskade::IterationParameters:

Public Member Functions
	IterationParameters (double desiredAccuracy_, int maxSteps_)

virtual	~IterationParameters ()

void	logStep ()
	Log all quantities in this class. More...

virtual void	reset ()
	Reset all quantities in this class. More...

Public Attributes
double	desiredAccuracy

int	maxSteps

int	termination

Protected Member Functions
virtual void	doForAll (LQAction::ToDo td)
	To be overloaded by derived class. More...

Friends
class	NewtonsMethod

Constructor & Destructor Documentation

◆ IterationParameters()

Kaskade::IterationParameters::IterationParameters	(	double	desiredAccuracy_,
		int	maxSteps_
	)

inline

Definition at line 132 of file algorithm_base.hh.

◆ ~IterationParameters()

virtual Kaskade::IterationParameters::~IterationParameters ( )

inlinevirtual

Definition at line 143 of file algorithm_base.hh.

Member Function Documentation

◆ doForAll()

virtual void Kaskade::IterationParameters::doForAll ( LQAction::ToDo td )

inlineprotectedvirtual

To be overloaded by derived class.

For any LoggedQuantity quant, declared in the derived class, insert quant.doAction(td)

Reimplemented in Kaskade::InteriorPointParameters, Kaskade::InteriorPointParametersSqrt, Kaskade::HypIPParameters, Kaskade::NewtonParameters, Kaskade::GuardedCovariantNewtonParameters, Kaskade::DampedCovariantNewtonParameters, and Kaskade::ModifiedCovariantNewtonParameters.

Definition at line 160 of file algorithm_base.hh.

Referenced by Kaskade::InteriorPointParameters::doForAll(), logStep(), and reset().

◆ logStep()

void Kaskade::IterationParameters::logStep ( )

inline

Log all quantities in this class.

Definition at line 146 of file algorithm_base.hh.

◆ reset()

virtual void Kaskade::IterationParameters::reset ( )

inlinevirtual

Reset all quantities in this class.

Reimplemented in Kaskade::InteriorPointParameters, and Kaskade::NewtonParameters.

Definition at line 151 of file algorithm_base.hh.

Referenced by Kaskade::HypIPParameters::HypIPParameters(), Kaskade::InteriorPointParametersSqrt::InteriorPointParametersSqrt(), Kaskade::InteriorPointParameters::reset(), Kaskade::CompositeStep::resetParameters(), and Kaskade::HypIP::resetParameters().

Friends And Related Function Documentation

◆ NewtonsMethod

friend class NewtonsMethod

friend

Definition at line 165 of file algorithm_base.hh.

Member Data Documentation

◆ desiredAccuracy

double Kaskade::IterationParameters::desiredAccuracy

Definition at line 139 of file algorithm_base.hh.

Referenced by Kaskade::CompositeStep::setDesiredAccuracy(), Kaskade::HypIP::setDesiredAccuracy(), and Kaskade::NewtonsMethod::setDesiredAccuracy().

◆ maxSteps

int Kaskade::IterationParameters::maxSteps

Definition at line 140 of file algorithm_base.hh.

Referenced by Kaskade::CompositeStep::maxSteps(), Kaskade::HypIP::maxSteps(), and Kaskade::NewtonsMethod::maxSteps().

◆ termination

int Kaskade::IterationParameters::termination

Definition at line 141 of file algorithm_base.hh.

The documentation for this class was generated from the following file:

algorithm_base.hh