Kaskade::Algorithm Class Reference

Base class for algorithms. Provides a unified interface and some simple wrapper routines, which perform optional timing, etc. More...

#include <algorithm_base.hh>

Detailed Description

Base class for algorithms. Provides a unified interface and some simple wrapper routines, which perform optional timing, etc.

Definition at line 174 of file algorithm_base.hh.

Inheritance diagram for Kaskade::Algorithm:

Public Member Functions
	Algorithm ()
virtual	~Algorithm ()
void	performTiming (bool doit)
void	reportOnIteration (int level)

Protected Member Functions
virtual void	initialize ()
virtual void	finalize (int)
virtual void	terminationMessage (int)
int	algorithmWrapper ()
	Run algorithm, completely with initialization and finalization. More...
int	oneStepWrapper ()
	Run one step of algorithm. More...

Protected Attributes
int	report

Constructor & Destructor Documentation

Algorithm()

Kaskade::Algorithm::Algorithm ( )

inline

Definition at line 178 of file algorithm_base.hh.

~Algorithm()

virtual Kaskade::Algorithm::~Algorithm ( )

inlinevirtual

Definition at line 179 of file algorithm_base.hh.

Member Function Documentation

algorithmWrapper()

int Kaskade::Algorithm::algorithmWrapper ( )

protected

Run algorithm, completely with initialization and finalization.

finalize()

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

inlineprotectedvirtual

Reimplemented in Kaskade::SimpleAdaptiveRefinement, Kaskade::TestErrorEstimator, and Kaskade::NewtonsMethod.

Definition at line 186 of file algorithm_base.hh.

initialize()

virtual void Kaskade::Algorithm::initialize ( )

inlineprotectedvirtual

Reimplemented in Kaskade::SimpleAdaptiveRefinement, Kaskade::TestErrorEstimator, Kaskade::HomotopyBase, Kaskade::InteriorPointSqrtModel, Kaskade::InteriorPointSlopeEstimate, Kaskade::NewtonsMethod, Kaskade::DampedCovariantNewtonMethod, and Kaskade::StateConstraintsNewtonMethod.

Definition at line 185 of file algorithm_base.hh.

oneStepWrapper()

int Kaskade::Algorithm::oneStepWrapper ( )

protected

Run one step of algorithm.

performTiming()

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

inline

Definition at line 181 of file algorithm_base.hh.

reportOnIteration()

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

inline

Definition at line 182 of file algorithm_base.hh.

terminationMessage()

virtual void Kaskade::Algorithm::terminationMessage ( int  )

protectedvirtual

Reimplemented in Kaskade::HomotopyBase, Kaskade::SimpleAdaptiveRefinement, Kaskade::TestErrorEstimator, Kaskade::CompositeStep, Kaskade::HypIP, and Kaskade::NewtonsMethod.

Member Data Documentation

report

int Kaskade::Algorithm::report

protected

Definition at line 193 of file algorithm_base.hh.

Referenced by reportOnIteration().

---

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

• algorithm_base.hh