mirtk::EnergyThreshold Class Reference

#include <EnergyThreshold.h>

Inheritance diagram for mirtk::EnergyThreshold:

Collaboration diagram for mirtk::EnergyThreshold:

Public Member Functions
	EnergyThreshold (const ObjectiveFunction *=NULL)
	Constructor.
	EnergyThreshold (const EnergyThreshold &)
	Copy constructor.
virtual bool	Fulfilled (int iter, double value, const double *delta)
virtual StoppingCriterion *	New () const
	Create new copy of this instance.
EnergyThreshold &	operator= (const EnergyThreshold &)
	Assignment operator.
virtual void	Print (ostream &) const
virtual	~EnergyThreshold ()
	Destructor.
Public Member Functions inherited from mirtk::StoppingCriterion
virtual void	Initialize ()
	Initialize stopping criterion after input and parameters are set.
virtual	~StoppingCriterion ()
	Destructor.
Public Member Functions inherited from mirtk::Object
virtual const char *	NameOfClass () const =0
	Get name of class, which this object is an instance of.
virtual ParameterList	Parameter () const
	Get parameter name/value pairs.
bool	Parameter (const ParameterList &)
	Set parameters from name/value pairs.
virtual bool	Set (const char *name, const char *value)
virtual	~Object ()
	Destructor.

Additional Inherited Members
Static Public Member Functions inherited from mirtk::Object
static const char *	NameOfType ()
	Get name of this class type.
Protected Member Functions inherited from mirtk::StoppingCriterion
StoppingCriterion &	operator= (const StoppingCriterion &)
	Assignment operator.
	StoppingCriterion (const ObjectiveFunction *=NULL)
	Constructor.
	StoppingCriterion (const LocalOptimizer *)
	Constructor.
	StoppingCriterion (const StoppingCriterion &)
	Copy constructor.
Protected Member Functions inherited from mirtk::Object
template<typename... Args>
void	Throw (ErrorType err, const char *func, Args... args) const
Static Protected Member Functions inherited from mirtk::Object
template<typename... Args>
static void	ThrowStatic (ErrorType err, const char *cls, const char *func, Args... args)

Detailed Description

Stops minimization when object function value falls below a given threshold

Definition at line 32 of file EnergyThreshold.h.

Member Function Documentation

Fulfilled()

virtual bool mirtk::EnergyThreshold::Fulfilled ( int  iter, double  value, const double *  delta  )

virtual

Test stopping criterion

Parameters

[in]	iter	Current number of iterations.
[in]	value	Objective function value at current iteration.
[in]	delta	Last change of objective function parameters.

Returns

Whether stopping criterion is fulfilled.

Implements mirtk::StoppingCriterion.

Print()

virtual void mirtk::EnergyThreshold::Print ( ostream &  ) const

virtual

Print current stopping criterion status / value

This function must be called after Fulfilled, which should update any cached values that are needed by this function to avoid a costly reevaluation of the stopping criterion.

Note

The printed string is expected to be considerably short and must not end with a newline or space characters.

Reimplemented from mirtk::StoppingCriterion.

---

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

• EnergyThreshold.h