ipo::detail::NewtonDescent::Stopping Class Reference

This class allows us to test suitable stopping conditions. More...

#include <NewtonDescent.hpp>

Collaboration diagram for ipo::detail::NewtonDescent::Stopping:

Public Member Functions
	Stopping (NewtonDescent const &newtonDescent)
	Constructor. More...
bool	operator() (size_t const iteration, double const fValue, gsl::vector const &gradient, gsl::vector const &vector, gsl::vector const &lastVector) const
	Test the stopping conditions. More...

Private Attributes
NewtonDescent const &	newtonDescent

Detailed Description

This class allows us to test suitable stopping conditions.

In particular it tests three:

1. relative gradient falls below gradTol
2. relative change in argument (max of elements) falls below stepTol
3. number of iterations exceeds iterMax The class gives us a function object and its operator returns true if the stopping conditions are met and false otherwise.

Definition at line 342 of file NewtonDescent.hpp.

Constructor & Destructor Documentation

NewtonDescent::Stopping::Stopping

(

NewtonDescent const &

newtonDescent

)

Constructor.

Parameters

newtonDescent

Designed to be constructed from *this

Definition at line 235 of file NewtonDescent.cc.

Member Function Documentation

bool NewtonDescent::Stopping::operator()	(	size_t const	iteration,
		double const	fValue,
		gsl::vector const &	gradient,
		gsl::vector const &	vector,
		gsl::vector const &	lastVector
	)		const

Test the stopping conditions.

Returns

true if the stopping conditions are met and false otherwise

Parameters

iteration	The iteration number
fValue	The function value
gradient	The gradient
vector	The vector function was evaluated at
lastVector	The previous vector function was evaluated at (may evaluate to false)

Returns

true if we should not stop, false if we should

Definition at line 240 of file NewtonDescent.cc.

References ipo::detail::NewtonDescent::Parameters::getf_typ(), ipo::detail::NewtonDescent::Parameters::getGradTol(), ipo::detail::NewtonDescent::getParameters(), ipo::detail::NewtonDescent::Parameters::getx_typ(), ipo::detail::NewtonDescent::gradTol, ipo::detail::NewtonDescent::iterMax, and ipo::detail::NewtonDescent::stepTol.

Member Data Documentation

NewtonDescent const& ipo::detail::NewtonDescent::Stopping::newtonDescent

private

Definition at line 364 of file NewtonDescent.hpp.

---

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

• NewtonDescent.hpp
• NewtonDescent.cc