Kaskade::NewtonParameters Class Reference

#include <newton_base.hh>

Detailed Description

Definition at line 19 of file newton_base.hh.

Inheritance diagram for Kaskade::NewtonParameters:

Public Member Functions
	NewtonParameters (double desiredAccuracy_, int maxSteps_)
virtual	~NewtonParameters ()
virtual void	reset ()
	Reset all quantities in this class. More...

Public Attributes
bool	reuseFactorization
double	desiredAccuracy
int	maxSteps
int	termination

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

Protected Attributes
LoggedQuantity< double >	normCorr

Friends
class	NewtonsMethod
class	SimpleNewtonMethod

Constructor & Destructor Documentation

NewtonParameters()

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

inline

Definition at line 22 of file newton_base.hh.

~NewtonParameters()

virtual Kaskade::NewtonParameters::~NewtonParameters ( )

inlinevirtual

Definition at line 33 of file newton_base.hh.

Member Function Documentation

doForAll()

virtual void Kaskade::NewtonParameters::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 from Kaskade::IterationParameters.

Reimplemented in Kaskade::GuardedCovariantNewtonParameters, Kaskade::DampedCovariantNewtonParameters, and Kaskade::ModifiedCovariantNewtonParameters.

Definition at line 49 of file newton_base.hh.

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

logStep()

void Kaskade::NewtonParameters::logStep ( )

inlineprotected

Definition at line 45 of file newton_base.hh.

Referenced by Kaskade::NewtonsMethod::logQuantities().

reset()

virtual void Kaskade::NewtonParameters::reset ( )

inlinevirtual

Reset all quantities in this class.

Reimplemented from Kaskade::IterationParameters.

Definition at line 35 of file newton_base.hh.

Referenced by Kaskade::DampedCovariantNewtonParameters::DampedCovariantNewtonParameters(), Kaskade::GuardedCovariantNewtonParameters::GuardedCovariantNewtonParameters(), NewtonParameters(), and Kaskade::NewtonsMethod::resetParameters().

Friends And Related Function Documentation

NewtonsMethod

friend class NewtonsMethod

friend

Definition at line 42 of file newton_base.hh.

SimpleNewtonMethod

friend class SimpleNewtonMethod

friend

Definition at line 43 of file newton_base.hh.

Member Data Documentation

desiredAccuracy

double Kaskade::IterationParameters::desiredAccuracy

inherited

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

inherited

Definition at line 140 of file algorithm_base.hh.

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

normCorr

LoggedQuantity<double> Kaskade::NewtonParameters::normCorr

protected

Definition at line 54 of file newton_base.hh.

Referenced by doForAll(), and Kaskade::StateConstraintsNewtonMethod::predictNextDampingFactor().

reuseFactorization

bool Kaskade::NewtonParameters::reuseFactorization

Definition at line 39 of file newton_base.hh.

Referenced by Kaskade::NewtonsMethod::resolve().

termination

int Kaskade::IterationParameters::termination

inherited

Definition at line 141 of file algorithm_base.hh.

---

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

• newton_base.hh