Kaskade::GuardedCovariantNewtonParameters Class Reference

Paramters that are used and Logged by GuardedCovariantNewtonMethod. More...

#include <newton_damped.hh>

Detailed Description

Paramters that are used and Logged by GuardedCovariantNewtonMethod.

Definition at line 11 of file newton_damped.hh.

Inheritance diagram for Kaskade::GuardedCovariantNewtonParameters:

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

Public Attributes
double	maxContraction
LoggedQuantity< double >	omega0
LoggedQuantity< double >	omega
double	accuracyReached
bool	reuseFactorization
double	desiredAccuracy
int	maxSteps
int	termination

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

Protected Attributes
LoggedQuantity< double >	Theta
LoggedQuantity< double >	normSCorr
LoggedQuantity< double >	normCorrLast
LoggedQuantity< double >	normCorr

Friends
class	GuardedCovariantNewtonMethod

Constructor & Destructor Documentation

GuardedCovariantNewtonParameters()

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

inline

Definition at line 14 of file newton_damped.hh.

Member Function Documentation

doForAll()

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

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

Definition at line 31 of file newton_damped.hh.

Referenced by Kaskade::DampedCovariantNewtonParameters::doForAll().

logStep()

void Kaskade::NewtonParameters::logStep ( )

inlineprotectedinherited

Definition at line 45 of file newton_base.hh.

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

reset()

virtual void Kaskade::NewtonParameters::reset ( )

inlinevirtualinherited

Reset all quantities in this class.

Reimplemented from Kaskade::IterationParameters.

Definition at line 35 of file newton_base.hh.

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

Friends And Related Function Documentation

GuardedCovariantNewtonMethod

friend class GuardedCovariantNewtonMethod

friend

Definition at line 29 of file newton_damped.hh.

Member Data Documentation

accuracyReached

double Kaskade::GuardedCovariantNewtonParameters::accuracyReached

Definition at line 26 of file newton_damped.hh.

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().

maxContraction

double Kaskade::GuardedCovariantNewtonParameters::maxContraction

Definition at line 23 of file newton_damped.hh.

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

protectedinherited

Definition at line 54 of file newton_base.hh.

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

normCorrLast

LoggedQuantity<double> Kaskade::GuardedCovariantNewtonParameters::normCorrLast

protected

Definition at line 43 of file newton_damped.hh.

Referenced by doForAll().

normSCorr

LoggedQuantity<double> Kaskade::GuardedCovariantNewtonParameters::normSCorr

protected

Definition at line 42 of file newton_damped.hh.

Referenced by doForAll().

omega

LoggedQuantity<double> Kaskade::GuardedCovariantNewtonParameters::omega

Definition at line 25 of file newton_damped.hh.

Referenced by doForAll().

omega0

LoggedQuantity<double> Kaskade::GuardedCovariantNewtonParameters::omega0

Definition at line 24 of file newton_damped.hh.

Referenced by doForAll().

reuseFactorization

bool Kaskade::NewtonParameters::reuseFactorization

inherited

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.

Theta

LoggedQuantity<double> Kaskade::GuardedCovariantNewtonParameters::Theta

protected

Definition at line 41 of file newton_damped.hh.

Referenced by doForAll().

---

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

• newton_damped.hh