itk::SingleValuedNonLinearVnlOptimizer Class Reference
[Numerics, Optimizers]

This class is a base for the Optimization methods that optimize a single valued function. More...

#include <itkSingleValuedNonLinearVnlOptimizer.h>

Inheritance diagram for itk::SingleValuedNonLinearVnlOptimizer:

[legend]Collaboration diagram for itk::SingleValuedNonLinearVnlOptimizer:

[legend]List of all members.

Public Types
typedef SingleValuedNonLinearVnlOptimizer	Self
typedef SingleValuedNonLinearOptimizer	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
Public Member Functions
virtual const char *	GetClassName () const
virtual void	SetCostFunction (SingleValuedCostFunction *costFunction)=0
Protected Types
typedef SingleValuedVnlCostFunctionAdaptor	CostFunctionAdaptorType
Protected Member Functions
	SingleValuedNonLinearVnlOptimizer ()
virtual	~SingleValuedNonLinearVnlOptimizer ()
void	SetCostFunctionAdaptor (CostFunctionAdaptorType *adaptor)
const CostFunctionAdaptorType *	GetCostFunctionAdaptor (void) const

---

Detailed Description

This class is a base for the Optimization methods that optimize a single valued function.

It is an Adaptor class for optimizers provided by the vnl library

Definition at line 35 of file itkSingleValuedNonLinearVnlOptimizer.h.

---

Member Typedef Documentation

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

Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer. Definition at line 43 of file itkSingleValuedNonLinearVnlOptimizer.h.

typedef SingleValuedVnlCostFunctionAdaptor itk::SingleValuedNonLinearVnlOptimizer::CostFunctionAdaptorType [protected]

Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer. Definition at line 61 of file itkSingleValuedNonLinearVnlOptimizer.h.

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

Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer. Definition at line 42 of file itkSingleValuedNonLinearVnlOptimizer.h.

typedef SingleValuedNonLinearVnlOptimizer itk::SingleValuedNonLinearVnlOptimizer::Self

Standard class typedefs. Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer. Definition at line 40 of file itkSingleValuedNonLinearVnlOptimizer.h.

typedef SingleValuedNonLinearOptimizer itk::SingleValuedNonLinearVnlOptimizer::Superclass

Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer. Definition at line 41 of file itkSingleValuedNonLinearVnlOptimizer.h.

---

Constructor & Destructor Documentation

itk::SingleValuedNonLinearVnlOptimizer::SingleValuedNonLinearVnlOptimizer (   )  [protected]

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

---

Member Function Documentation

virtual const char* itk::SingleValuedNonLinearVnlOptimizer::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SingleValuedNonLinearOptimizer. Reimplemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer.

const CostFunctionAdaptorType* itk::SingleValuedNonLinearVnlOptimizer::GetCostFunctionAdaptor (  void   )  const [protected]

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

Set the cost Function. This method has to be overloaded by derived classes because the CostFunctionAdaptor requires to know the number of parameters at construction time. This number of parameters is obtained at run-time from the itkCostFunction. As a consequence each derived optimizer should construct its own CostFunctionAdaptor when overloading this method Implemented in itk::AmoebaOptimizer, itk::ConjugateGradientOptimizer, and itk::LBFGSOptimizer.

void itk::SingleValuedNonLinearVnlOptimizer::SetCostFunctionAdaptor (  CostFunctionAdaptorType *  adaptor  )  [protected]

---

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

• itkSingleValuedNonLinearVnlOptimizer.h

---