KASKADE 7 development version
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Kaskade::InteriorPointSlopeEstimate Class Reference

#include <homotopy_base.hh>

Detailed Description

Definition at line 305 of file homotopy_base.hh.

Inheritance diagram for Kaskade::InteriorPointSlopeEstimate:
Kaskade::HomotopyBase Kaskade::Algorithm

Public Member Functions

 InteriorPointSlopeEstimate (NewtonsMethod &n_, AbstractNorm const &norm_, InteriorPointParameters &p_, AbstractNewtonDirection &solver_, AbstractNorm const *normPlain_=0, NewtonsMethod *finalsolver_=0)
 
virtual void initialize ()
 Optional overload by derived class. More...
 
virtual void finalize ()
 Optional overload by derived class. More...
 
virtual double muOnSuccess (int step)
 New mu if corrector was successful. More...
 
virtual double muOnFailure ()
 New mu if corrector failed. More...
 
virtual double muFinal ()
 mu for successful termination More...
 
virtual void updateModelOfHomotopy (int step)
 update of path parameters, e.g. eta and omega More...
 
virtual void computePredictor (int step)
 Default: classical predictor. More...
 
virtual void initializeCorrector ()
 what should be done before corrector More...
 
virtual void finalizeCorrector ()
 what should be done after corrector More...
 
virtual void finalizeHomotopy ()
 to be performed, if convergence of path has occured More...
 
virtual void updateIterate ()
 make trial iterate to current iterate (on successful corrector) More...
 
virtual void recoverIterate ()
 make old iterate to current iterate (on failed corrector) More...
 
virtual double lengthOfPath ()
 estimate of length of homopoty path More...
 
virtual void logQuantities ()
 
void printDiagnosis ()
 
void solve (AbstractParameterFunctional *f, AbstractFunctionSpaceElement &x)
 
void performTiming (bool doit)
 
void reportOnIteration (int level)
 

Protected Member Functions

virtual void finalize (int)
 
virtual int convergenceTest ()
 convergence test. returns true if method converged and solution is found. More...
 
virtual void terminationMessage (int errorFlag)
 output of a termination message More...
 
int algorithmWrapper ()
 Run algorithm, completely with initialization and finalization. More...
 
int oneStepWrapper ()
 Run one step of algorithm. More...
 

Protected Attributes

NewtonsMethodcorrector
 
InteriorPointParametersp
 
AbstractParameterFunctionalfunctional
 
std::unique_ptr< AbstractFunctionSpaceElementtrialIterate
 
int step
 
int report
 

Constructor & Destructor Documentation

◆ InteriorPointSlopeEstimate()

Kaskade::InteriorPointSlopeEstimate::InteriorPointSlopeEstimate ( NewtonsMethod n_,
AbstractNorm const &  norm_,
InteriorPointParameters p_,
AbstractNewtonDirection solver_,
AbstractNorm const *  normPlain_ = 0,
NewtonsMethod finalsolver_ = 0 
)
inline

Definition at line 309 of file homotopy_base.hh.

Member Function Documentation

◆ algorithmWrapper()

int Kaskade::Algorithm::algorithmWrapper ( )
protectedinherited

Run algorithm, completely with initialization and finalization.

◆ computePredictor()

virtual void Kaskade::InteriorPointSlopeEstimate::computePredictor ( int  step)
inlinevirtual

Default: classical predictor.

Reimplemented from Kaskade::HomotopyBase.

Definition at line 340 of file homotopy_base.hh.

◆ convergenceTest()

virtual int Kaskade::HomotopyBase::convergenceTest ( )
protectedvirtualinherited

convergence test. returns true if method converged and solution is found.

◆ finalize() [1/2]

virtual void Kaskade::InteriorPointSlopeEstimate::finalize ( )
inlinevirtual

Optional overload by derived class.

Reimplemented from Kaskade::HomotopyBase.

Definition at line 327 of file homotopy_base.hh.

◆ finalize() [2/2]

virtual void Kaskade::Algorithm::finalize ( int  )
inlineprotectedvirtualinherited

◆ finalizeCorrector()

virtual void Kaskade::InteriorPointSlopeEstimate::finalizeCorrector ( )
inlinevirtual

what should be done after corrector

Implements Kaskade::HomotopyBase.

Definition at line 344 of file homotopy_base.hh.

◆ finalizeHomotopy()

virtual void Kaskade::InteriorPointSlopeEstimate::finalizeHomotopy ( )
virtual

to be performed, if convergence of path has occured

Reimplemented from Kaskade::HomotopyBase.

◆ initialize()

virtual void Kaskade::InteriorPointSlopeEstimate::initialize ( )
inlinevirtual

Optional overload by derived class.

Reimplemented from Kaskade::HomotopyBase.

Definition at line 322 of file homotopy_base.hh.

◆ initializeCorrector()

virtual void Kaskade::InteriorPointSlopeEstimate::initializeCorrector ( )
virtual

what should be done before corrector

Implements Kaskade::HomotopyBase.

◆ lengthOfPath()

virtual double Kaskade::InteriorPointSlopeEstimate::lengthOfPath ( )
inlinevirtual

estimate of length of homopoty path

Implements Kaskade::HomotopyBase.

Definition at line 353 of file homotopy_base.hh.

◆ logQuantities()

virtual void Kaskade::InteriorPointSlopeEstimate::logQuantities ( )
inlinevirtual

Reimplemented from Kaskade::HomotopyBase.

Definition at line 361 of file homotopy_base.hh.

◆ muFinal()

virtual double Kaskade::InteriorPointSlopeEstimate::muFinal ( )
inlinevirtual

mu for successful termination

Implements Kaskade::HomotopyBase.

Definition at line 336 of file homotopy_base.hh.

◆ muOnFailure()

virtual double Kaskade::InteriorPointSlopeEstimate::muOnFailure ( )
inlinevirtual

New mu if corrector failed.

Implements Kaskade::HomotopyBase.

Definition at line 331 of file homotopy_base.hh.

◆ muOnSuccess()

virtual double Kaskade::InteriorPointSlopeEstimate::muOnSuccess ( int  step)
virtual

New mu if corrector was successful.

Implements Kaskade::HomotopyBase.

◆ oneStepWrapper()

int Kaskade::Algorithm::oneStepWrapper ( )
protectedinherited

Run one step of algorithm.

◆ performTiming()

void Kaskade::Algorithm::performTiming ( bool  doit)
inlineinherited

Definition at line 181 of file algorithm_base.hh.

◆ printDiagnosis()

void Kaskade::InteriorPointSlopeEstimate::printDiagnosis ( )

Referenced by logQuantities().

◆ recoverIterate()

virtual void Kaskade::InteriorPointSlopeEstimate::recoverIterate ( )
inlinevirtual

make old iterate to current iterate (on failed corrector)

Implements Kaskade::HomotopyBase.

Definition at line 350 of file homotopy_base.hh.

◆ reportOnIteration()

void Kaskade::Algorithm::reportOnIteration ( int  level)
inlineinherited

Definition at line 182 of file algorithm_base.hh.

◆ solve()

void Kaskade::HomotopyBase::solve ( AbstractParameterFunctional f,
AbstractFunctionSpaceElement x 
)
inherited

◆ terminationMessage()

virtual void Kaskade::HomotopyBase::terminationMessage ( int  errorFlag)
protectedvirtualinherited

output of a termination message

Reimplemented from Kaskade::Algorithm.

◆ updateIterate()

virtual void Kaskade::InteriorPointSlopeEstimate::updateIterate ( )
virtual

make trial iterate to current iterate (on successful corrector)

Implements Kaskade::HomotopyBase.

◆ updateModelOfHomotopy()

virtual void Kaskade::InteriorPointSlopeEstimate::updateModelOfHomotopy ( int  step)
virtual

update of path parameters, e.g. eta and omega

Implements Kaskade::HomotopyBase.

Member Data Documentation

◆ corrector

NewtonsMethod& Kaskade::HomotopyBase::corrector
protectedinherited

◆ functional

AbstractParameterFunctional* Kaskade::HomotopyBase::functional
protectedinherited

Definition at line 157 of file homotopy_base.hh.

◆ p

InteriorPointParameters& Kaskade::HomotopyBase::p
protectedinherited

◆ report

int Kaskade::Algorithm::report
protectedinherited

Definition at line 193 of file algorithm_base.hh.

Referenced by Kaskade::Algorithm::reportOnIteration().

◆ step

int Kaskade::HomotopyBase::step
protectedinherited

Definition at line 160 of file homotopy_base.hh.

◆ trialIterate

std::unique_ptr<AbstractFunctionSpaceElement> Kaskade::HomotopyBase::trialIterate
protectedinherited

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