RVLUmin::UMinStepLS< Scalar > Class Template Reference

Base class for Unconstrained Minimization step algorithms with globalization via line search. More...

#include <uminstep.hh>

Inheritance diagram for RVLUmin::UMinStepLS< Scalar >:

List of all members.

Public Member Functions
	UMinStepLS (FunctionalEvaluation< Scalar > &_fx, UMinDir< Scalar > &_dc, LineSearchAlg< Scalar > &_ls, ostream &_str=cout)
	Initialize with the functional and the starting point for the optimization.
	UMinStepLS (const UMinStepLS< Scalar > &cos)
virtual	~UMinStepLS ()
Vector< Scalar > const &	getBasePoint ()
	Return a reference to the base point for the step.
Vector< Scalar > const &	getBaseGradient ()
	Return a reference to the gradient at the bast point.
FunctionalEvaluation< Scalar > &	getFunctionalEvaluation ()
	Return a reference to the functional evaluation at the trial point.
void	run ()
bool	query ()

---

Detailed Description

template<class Scalar>
class RVLUmin::UMinStepLS< Scalar >

Base class for Unconstrained Minimization step algorithms with globalization via line search.

Provides the added functionality of maintaining the functional evaluations and states correctly when set, and providing external access to such states. The functional evaluation may be set to avoid recomputing result in the calling object.

On call, x0 = base point for search fx = functional evaluation at x0

On return, x = minimizer estimate fx = functional evaluation at x

The state is always the point x.

Definition at line 99 of file uminstep.hh.

---

Constructor & Destructor Documentation

template<class Scalar>

RVLUmin::UMinStepLS< Scalar >::UMinStepLS	(	FunctionalEvaluation< Scalar > &	_fx,
		UMinDir< Scalar > &	_dc,
		LineSearchAlg< Scalar > &	_ls,
		ostream &	_str = cout
	)

Initialize with the functional and the starting point for the optimization.

Definition at line 167 of file uminstep.hh.

template<class Scalar>

RVLUmin::UMinStepLS< Scalar >::UMinStepLS

(

const UMinStepLS< Scalar > &

cos

)

Definition at line 173 of file uminstep.hh.

template<class Scalar>

virtual RVLUmin::UMinStepLS< Scalar >::~UMinStepLS

(

)

[virtual]

Definition at line 176 of file uminstep.hh.

---

Member Function Documentation

template<class Scalar>

Vector<Scalar> const& RVLUmin::UMinStepLS< Scalar >::getBasePoint

(

)

Return a reference to the base point for the step.

Definition at line 179 of file uminstep.hh.

template<class Scalar>

Vector<Scalar> const& RVLUmin::UMinStepLS< Scalar >::getBaseGradient

(

)

Return a reference to the gradient at the bast point.

Definition at line 182 of file uminstep.hh.

template<class Scalar>

FunctionalEvaluation<Scalar>& RVLUmin::UMinStepLS< Scalar >::getFunctionalEvaluation

(

)

Return a reference to the functional evaluation at the trial point.

Definition at line 185 of file uminstep.hh.

template<class Scalar>

void RVLUmin::UMinStepLS< Scalar >::run

(

)

[virtual]

Implements RVLAlg::Algorithm.

Definition at line 187 of file uminstep.hh.

References RVL::RVLException::what().

template<class Scalar>

bool RVLUmin::UMinStepLS< Scalar >::query

(

)

[virtual]

Implements RVLAlg::Terminator.

Definition at line 205 of file uminstep.hh.

---

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

• uminstep.hh

---