nonlinear optimization with a simplex More...

#include <vtkAmoebaMinimizer.h>

Inheritance diagram for vtkAmoebaMinimizer:

Collaboration diagram for vtkAmoebaMinimizer:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAmoebaMinimizer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	SetFunction (void(f)(void ), void *arg)

void	SetFunctionArgDelete (void(f)(void ))

const char *	GetParameterName (int i)

int	GetNumberOfParameters ()

void	Initialize ()

virtual void	Minimize ()

virtual int	Iterate ()

void	EvaluateFunction ()


void	SetParameterValue (const char *name, double value)

void	SetParameterValue (int i, double value)


void	SetParameterScale (const char *name, double scale)

double	GetParameterScale (const char *name)

void	SetParameterScale (int i, double scale)

double	GetParameterScale (int i)


double	GetParameterValue (const char *name)

double	GetParameterValue (int i)


virtual void	SetFunctionValue (double)

double	GetFunctionValue ()


virtual void	SetContractionRatio (double)

virtual double	GetContractionRatio ()


virtual void	SetExpansionRatio (double)

virtual double	GetExpansionRatio ()


virtual void	SetTolerance (double)

virtual double	GetTolerance ()


virtual void	SetParameterTolerance (double)

virtual double	GetParameterTolerance ()


virtual void	SetMaxIterations (int)

virtual int	GetMaxIterations ()


virtual int	GetIterations ()


virtual int	GetFunctionEvaluations ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkAmoebaMinimizer *	New ()

static int	IsTypeOf (const char *type)

static vtkAmoebaMinimizer *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAmoebaMinimizer ()

	~vtkAmoebaMinimizer ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
void(*	Function )(void *)

void(*	FunctionArgDelete )(void *)

void *	FunctionArg

int	NumberOfParameters

char **	ParameterNames

double *	ParameterValues

double *	ParameterScales

double	FunctionValue

double	ContractionRatio

double	ExpansionRatio

double	Tolerance

double	ParameterTolerance

int	MaxIterations

int	Iterations

int	FunctionEvaluations

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

nonlinear optimization with a simplex

vtkAmoebaMinimizer will modify a set of parameters in order to find the minimum of a specified function. The method used is commonly known as the amoeba method, it constructs an n-dimensional simplex in parameter space (i.e. a tetrahedron if the number or parameters is 3) and moves the vertices around parameter space until a local minimum is found. The amoeba method is robust, reasonably efficient, but is not guaranteed to find the global minimum if several local minima exist.

Tests:: vtkAmoebaMinimizer (Tests)

Definition at line 37 of file vtkAmoebaMinimizer.h.

Member Typedef Documentation

typedef vtkObject vtkAmoebaMinimizer::Superclass

Definition at line 41 of file vtkAmoebaMinimizer.h.

Constructor & Destructor Documentation

vtkAmoebaMinimizer::vtkAmoebaMinimizer ( )

protected

vtkAmoebaMinimizer::~vtkAmoebaMinimizer ( )

protected

Member Function Documentation

static vtkAmoebaMinimizer* vtkAmoebaMinimizer::New ( )

static

static int vtkAmoebaMinimizer::IsTypeOf ( const char * type )

static

virtual int vtkAmoebaMinimizer::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkAmoebaMinimizer* vtkAmoebaMinimizer::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkAmoebaMinimizer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkAmoebaMinimizer* vtkAmoebaMinimizer::NewInstance ( ) const

void vtkAmoebaMinimizer::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

void vtkAmoebaMinimizer::SetFunction	(	void()(void )	f,
		void *	arg
	)

Specify the function to be minimized. When this function is called, it must get the parameter values by calling GetParameterValue() for each parameter, and then must call SetFunctionValue() to tell the minimizer what the result of the function evaluation was. The number of function evaluations used for the minimization can be retrieved using GetFunctionEvaluations().

void vtkAmoebaMinimizer::SetFunctionArgDelete ( void(*)(void *) f )

Set a function to call when a void* argument is being discarded.

void vtkAmoebaMinimizer::SetParameterValue	(	const char *	name,
		double	value
	)

Set the initial value for the specified parameter. Calling this function for any parameter will reset the Iterations and the FunctionEvaluations counts to zero. You must also use SetParameterScale() to specify the step size by which the parameter will be modified during the minimization. It is preferable to specify parameters by name, rather than by number.

void vtkAmoebaMinimizer::SetParameterValue	(	int	i,
		double	value
	)

Set the initial value for the specified parameter. Calling this function for any parameter will reset the Iterations and the FunctionEvaluations counts to zero. You must also use SetParameterScale() to specify the step size by which the parameter will be modified during the minimization. It is preferable to specify parameters by name, rather than by number.

void vtkAmoebaMinimizer::SetParameterScale	(	const char *	name,
		double	scale
	)

Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.

double vtkAmoebaMinimizer::GetParameterScale ( const char * name )

Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.

void vtkAmoebaMinimizer::SetParameterScale	(	int	i,
		double	scale
	)

Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.

double vtkAmoebaMinimizer::GetParameterScale ( int i )

inline

Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.

Definition at line 74 of file vtkAmoebaMinimizer.h.

double vtkAmoebaMinimizer::GetParameterValue ( const char * name )

Get the value of a parameter at the current stage of the minimization. Call this method within the function that you are minimizing in order to get the current parameter values. It is preferable to specify parameters by name rather than by index.

double vtkAmoebaMinimizer::GetParameterValue ( int i )

inline

Get the value of a parameter at the current stage of the minimization. Call this method within the function that you are minimizing in order to get the current parameter values. It is preferable to specify parameters by name rather than by index.

Definition at line 83 of file vtkAmoebaMinimizer.h.

const char* vtkAmoebaMinimizer::GetParameterName ( int i )

inline

For completeness, an unchecked method to get the name for particular parameter (the result will be NULL if no name was set).

Definition at line 88 of file vtkAmoebaMinimizer.h.

int vtkAmoebaMinimizer::GetNumberOfParameters ( )

inline

Get the number of parameters that have been set.

Definition at line 91 of file vtkAmoebaMinimizer.h.

void vtkAmoebaMinimizer::Initialize ( )

Initialize the minimizer. This will reset the number of parameters to zero so that the minimizer can be reused.

virtual void vtkAmoebaMinimizer::Minimize ( )

virtual

Iterate until the minimum is found to within the specified tolerance, or until the MaxIterations has been reached.

virtual int vtkAmoebaMinimizer::Iterate ( )

virtual

Perform one iteration of minimization. Returns zero if the tolerance stopping criterion has been met.

virtual void vtkAmoebaMinimizer::SetFunctionValue ( double )

virtual

Get the function value resulting from the minimization.

double vtkAmoebaMinimizer::GetFunctionValue ( )

inline

Get the function value resulting from the minimization.

Definition at line 108 of file vtkAmoebaMinimizer.h.

virtual void vtkAmoebaMinimizer::SetContractionRatio ( double )

virtual

Set the amoeba contraction ratio. The default value of 0.5 gives fast convergence, but larger values such as 0.6 or 0.7 provide greater stability.

virtual double vtkAmoebaMinimizer::GetContractionRatio ( )

virtual

Set the amoeba contraction ratio. The default value of 0.5 gives fast convergence, but larger values such as 0.6 or 0.7 provide greater stability.

virtual void vtkAmoebaMinimizer::SetExpansionRatio ( double )

virtual

Set the amoeba expansion ratio. The default value is 2.0, which provides rapid expansion. Values between 1.1 and 2.0 are valid.

virtual double vtkAmoebaMinimizer::GetExpansionRatio ( )

virtual

Set the amoeba expansion ratio. The default value is 2.0, which provides rapid expansion. Values between 1.1 and 2.0 are valid.

virtual void vtkAmoebaMinimizer::SetTolerance ( double )

virtual

Specify the value tolerance to aim for during the minimization.

virtual double vtkAmoebaMinimizer::GetTolerance ( )

virtual

Specify the value tolerance to aim for during the minimization.

virtual void vtkAmoebaMinimizer::SetParameterTolerance ( double )

virtual

Specify the parameter tolerance to aim for during the minimization.

virtual double vtkAmoebaMinimizer::GetParameterTolerance ( )

virtual

Specify the parameter tolerance to aim for during the minimization.

virtual void vtkAmoebaMinimizer::SetMaxIterations ( int )

virtual

Specify the maximum number of iterations to try before giving up.

virtual int vtkAmoebaMinimizer::GetMaxIterations ( )

virtual

Specify the maximum number of iterations to try before giving up.

virtual int vtkAmoebaMinimizer::GetIterations ( )

virtual

Return the number of interations that have been performed. This is not necessarily the same as the number of function evaluations.

virtual int vtkAmoebaMinimizer::GetFunctionEvaluations ( )

virtual

Return the number of times that the function has been evaluated.

void vtkAmoebaMinimizer::EvaluateFunction ( )

Evaluate the function. This is usually called internally by the minimization code, but it is provided here as a public method.

Member Data Documentation

void(* vtkAmoebaMinimizer::Function) (void *)

protected

Definition at line 164 of file vtkAmoebaMinimizer.h.

void(* vtkAmoebaMinimizer::FunctionArgDelete) (void *)

protected

Definition at line 165 of file vtkAmoebaMinimizer.h.

void* vtkAmoebaMinimizer::FunctionArg

protected

Definition at line 166 of file vtkAmoebaMinimizer.h.

int vtkAmoebaMinimizer::NumberOfParameters

protected

Definition at line 169 of file vtkAmoebaMinimizer.h.

char** vtkAmoebaMinimizer::ParameterNames

protected

Definition at line 170 of file vtkAmoebaMinimizer.h.

double* vtkAmoebaMinimizer::ParameterValues

protected

Definition at line 171 of file vtkAmoebaMinimizer.h.

double* vtkAmoebaMinimizer::ParameterScales

protected

Definition at line 172 of file vtkAmoebaMinimizer.h.

double vtkAmoebaMinimizer::FunctionValue

protected

Definition at line 173 of file vtkAmoebaMinimizer.h.

double vtkAmoebaMinimizer::ContractionRatio

protected

Definition at line 175 of file vtkAmoebaMinimizer.h.

double vtkAmoebaMinimizer::ExpansionRatio

protected

Definition at line 176 of file vtkAmoebaMinimizer.h.

double vtkAmoebaMinimizer::Tolerance

protected

Definition at line 178 of file vtkAmoebaMinimizer.h.

double vtkAmoebaMinimizer::ParameterTolerance

protected

Definition at line 179 of file vtkAmoebaMinimizer.h.

int vtkAmoebaMinimizer::MaxIterations

protected

Definition at line 180 of file vtkAmoebaMinimizer.h.

int vtkAmoebaMinimizer::Iterations

protected

Definition at line 181 of file vtkAmoebaMinimizer.h.

int vtkAmoebaMinimizer::FunctionEvaluations

protected

Definition at line 182 of file vtkAmoebaMinimizer.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Math/vtkAmoebaMinimizer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation