Wrap of the vnl_lbfgs algorithm. More...

#include <itkLBFGSOptimizer.h>

Inheritance diagram for itk::LBFGSOptimizer:

Collaboration diagram for itk::LBFGSOptimizer:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef vnl_lbfgs	InternalOptimizerType
typedef vnl_vector< double >	InternalParametersType
typedef SmartPointer< Self >	Pointer
typedef LBFGSOptimizer	Self
typedef SingleValuedNonLinearVnlOptimizer	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual double	GetDefaultStepLength ()
virtual double	GetGradientConvergenceTolerance ()
virtual double	GetLineSearchAccuracy ()
virtual unsigned int	GetMaximumNumberOfFunctionEvaluations ()
virtual const char *	GetNameOfClass () const
vnl_lbfgs *	GetOptimizer (void)
const std::string	GetStopConditionDescription () const
virtual bool	GetTrace ()
MeasureType	GetValue () const
virtual void	SetCostFunction (SingleValuedCostFunction *costFunction)
virtual void	SetDefaultStepLength (double stp)
virtual void	SetGradientConvergenceTolerance (double gtol)
virtual void	SetLineSearchAccuracy (double tol)
virtual void	SetMaximumNumberOfFunctionEvaluations (unsigned int n)
virtual void	SetTrace (bool flag)
void	StartOptimization (void)
virtual void	TraceOff ()
virtual void	TraceOn ()
Static Public Member Functions
static Pointer	New ()
Protected Types
typedef Superclass::CostFunctionAdaptorType	CostFunctionAdaptorType
Protected Member Functions
	LBFGSOptimizer ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~LBFGSOptimizer ()
Private Member Functions
	LBFGSOptimizer (const Self &)
void	operator= (const Self &)
Private Attributes
double	m_DefaultStepLength
double	m_GradientConvergenceTolerance
double	m_LineSearchAccuracy
unsigned int	m_MaximumNumberOfFunctionEvaluations
bool	m_OptimizerInitialized
std::ostringstream	m_StopConditionDescription
bool	m_Trace
InternalOptimizerType *	m_VnlOptimizer

Detailed Description

Wrap of the vnl_lbfgs algorithm.

Definition at line 32 of file itkLBFGSOptimizer.h.

Member Typedef Documentation

typedef SmartPointer< const Self > itk::LBFGSOptimizer::ConstPointer

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 40 of file itkLBFGSOptimizer.h.

typedef Superclass::CostFunctionAdaptorType itk::LBFGSOptimizer::CostFunctionAdaptorType [protected]

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 114 of file itkLBFGSOptimizer.h.

typedef vnl_lbfgs itk::LBFGSOptimizer::InternalOptimizerType

Internal optimizer type.

Definition at line 52 of file itkLBFGSOptimizer.h.

typedef vnl_vector< double > itk::LBFGSOptimizer::InternalParametersType

InternalParameters typedef.

Definition at line 46 of file itkLBFGSOptimizer.h.

typedef SmartPointer< Self > itk::LBFGSOptimizer::Pointer

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 39 of file itkLBFGSOptimizer.h.

typedef LBFGSOptimizer itk::LBFGSOptimizer::Self

Standard "Self" typedef.

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 37 of file itkLBFGSOptimizer.h.

typedef SingleValuedNonLinearVnlOptimizer itk::LBFGSOptimizer::Superclass

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

Definition at line 38 of file itkLBFGSOptimizer.h.

Constructor & Destructor Documentation

itk::LBFGSOptimizer::LBFGSOptimizer ( ) [protected]

virtual itk::LBFGSOptimizer::~LBFGSOptimizer ( ) [protected, virtual]

itk::LBFGSOptimizer::LBFGSOptimizer ( const Self & ) [private]

Member Function Documentation

virtual::itk::LightObject::Pointer itk::LBFGSOptimizer::CreateAnother ( void ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::SingleValuedNonLinearOptimizer.

virtual double itk::LBFGSOptimizer::GetDefaultStepLength ( ) [virtual]

virtual double itk::LBFGSOptimizer::GetGradientConvergenceTolerance ( ) [virtual]

virtual double itk::LBFGSOptimizer::GetLineSearchAccuracy ( ) [virtual]

virtual unsigned int itk::LBFGSOptimizer::GetMaximumNumberOfFunctionEvaluations ( ) [virtual]

virtual const char* itk::LBFGSOptimizer::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

vnl_lbfgs* itk::LBFGSOptimizer::GetOptimizer ( void )

Method for getting access to the internal optimizer.

const std::string itk::LBFGSOptimizer::GetStopConditionDescription ( ) const [virtual]

Get the reason for termination

Reimplemented from itk::Optimizer.

virtual bool itk::LBFGSOptimizer::GetTrace ( ) [virtual]

MeasureType itk::LBFGSOptimizer::GetValue ( ) const

Return Current Value

static Pointer itk::LBFGSOptimizer::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::SingleValuedNonLinearOptimizer.

void itk::LBFGSOptimizer::operator= ( const Self & ) [private]

Types inherited from the superclass

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

void itk::LBFGSOptimizer::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

Print out internal state

Reimplemented from itk::SingleValuedNonLinearVnlOptimizer.

virtual void itk::LBFGSOptimizer::SetCostFunction ( SingleValuedCostFunction * costFunction ) [virtual]

Plug in a Cost Function into the optimizer

Implements itk::SingleValuedNonLinearVnlOptimizer.

virtual void itk::LBFGSOptimizer::SetDefaultStepLength ( double stp ) [virtual]

Set/Get the default step size. This is a positive real number with a default value of 1.0 which determines the stpe size in the line search.

virtual void itk::LBFGSOptimizer::SetGradientConvergenceTolerance ( double gtol ) [virtual]

Set/Get the gradient convergence tolerance. This is a positive real number that determines the accuracy with which the solution is to be found. The optimization terminates when: ||G|| < gtol max(1,||X||) where ||.|| denotes the Euclidean norm.

virtual void itk::LBFGSOptimizer::SetLineSearchAccuracy ( double tol ) [virtual]

Set/Get the line search accuracy. This is a positive real number with a default value of 0.9, which controls the accuracy of the line search. If the function and gradient evalutions are inexpensive with respect to the cost of the iterations it may be advantageous to set the value to a small value (say 0.1).

virtual void itk::LBFGSOptimizer::SetMaximumNumberOfFunctionEvaluations ( unsigned int n ) [virtual]

Set/Get the maximum number of function evaluations allowed.

virtual void itk::LBFGSOptimizer::SetTrace ( bool flag ) [virtual]

Set/Get the optimizer trace flag. If set to true, the optimizer prints out information every iteration.

void itk::LBFGSOptimizer::StartOptimization ( void ) [virtual]

Start optimization with an initial value.

Reimplemented from itk::Optimizer.

virtual void itk::LBFGSOptimizer::TraceOff ( ) [virtual]

virtual void itk::LBFGSOptimizer::TraceOn ( ) [virtual]