FREE::ES::EvolutionaryStrategyOptimizerBase Class Reference
[Evolutionary strategies]

The basis for evolutionary strategy optimizers. More...

#include <freEvolutionaryStrategyOptimizerBase.h>

Inheritance diagram for FREE::ES::EvolutionaryStrategyOptimizerBase:

[legend]

List of all members.

Public Types
typedef EvolutionaryStrategyOptimizerBase	Self
typedef itk::SingleValuedNonLinearOptimizer	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef itk::SingleValuedCostFunction	CostFunctionType
typedef CostFunctionType::Pointer	CostFunctionPointer
Public Member Functions
	itkTypeMacro (EvolutionaryStrategyOptimizerBase, SingleValuedNonLinearOptimizer)
	itkSetMacro (MaximumIteration, unsigned int)
	itkGetConstReferenceMacro (MaximumIteration, unsigned int)
	itkGetConstReferenceMacro (CurrentCost, MeasureType)
MeasureType	GetValue () const
	itkGetConstReferenceMacro (CurrentIteration, unsigned int)
	itkSetMacro (Maximize, bool)
	itkGetConstMacro (Maximize, bool)
	itkBooleanMacro (Maximize)
bool	GetMinimize () const
void	SetMinimize (bool v)
void	MinimizeOn (void)
void	MinimizeOff (void)
virtual void	StartOptimization ()=0
virtual void	StopOptimization ()
virtual void	ResumeOptimization ()
Protected Member Functions
	EvolutionaryStrategyOptimizerBase ()
	EvolutionaryStrategyOptimizerBase (const EvolutionaryStrategyOptimizerBase &)
virtual	~EvolutionaryStrategyOptimizerBase ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const
Protected Attributes
bool	m_Stop
bool	m_Started
unsigned int	m_CurrentIteration
MeasureType	m_CurrentCost
Private Attributes
unsigned int	m_MaximumIteration
bool	m_Maximize

---

Detailed Description

The basis for evolutionary strategy optimizers.

This is the basis class for optimizers based on the concept of evolutionary optimization.

Definition at line 41 of file freEvolutionaryStrategyOptimizerBase.h.

---

Member Typedef Documentation

typedef EvolutionaryStrategyOptimizerBase FREE::ES::EvolutionaryStrategyOptimizerBase::Self

Standard "Self" typedef.

Reimplemented in FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >.

Definition at line 46 of file freEvolutionaryStrategyOptimizerBase.h.

typedef itk::SingleValuedNonLinearOptimizer FREE::ES::EvolutionaryStrategyOptimizerBase::Superclass

Reimplemented in FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >.

Definition at line 47 of file freEvolutionaryStrategyOptimizerBase.h.

typedef itk::SmartPointer<Self> FREE::ES::EvolutionaryStrategyOptimizerBase::Pointer

Reimplemented in FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >.

Definition at line 48 of file freEvolutionaryStrategyOptimizerBase.h.

typedef itk::SmartPointer<const Self> FREE::ES::EvolutionaryStrategyOptimizerBase::ConstPointer

Reimplemented in FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >.

Definition at line 49 of file freEvolutionaryStrategyOptimizerBase.h.

typedef itk::SingleValuedCostFunction FREE::ES::EvolutionaryStrategyOptimizerBase::CostFunctionType

Type of the Cost Function

Reimplemented in FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >.

Definition at line 55 of file freEvolutionaryStrategyOptimizerBase.h.

typedef CostFunctionType::Pointer FREE::ES::EvolutionaryStrategyOptimizerBase::CostFunctionPointer

Reimplemented in FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >.

Definition at line 56 of file freEvolutionaryStrategyOptimizerBase.h.

---

Constructor & Destructor Documentation

FREE::ES::EvolutionaryStrategyOptimizerBase::EvolutionaryStrategyOptimizerBase

(

)

[protected]

Definition at line 33 of file freEvolutionaryStrategyOptimizerBase.cxx.

FREE::ES::EvolutionaryStrategyOptimizerBase::EvolutionaryStrategyOptimizerBase

(

const EvolutionaryStrategyOptimizerBase &

)

[protected]

FREE::ES::EvolutionaryStrategyOptimizerBase::~EvolutionaryStrategyOptimizerBase

(

)

[protected, virtual]

Definition at line 43 of file freEvolutionaryStrategyOptimizerBase.cxx.

---

Member Function Documentation

FREE::ES::EvolutionaryStrategyOptimizerBase::itkTypeMacro	(	EvolutionaryStrategyOptimizerBase	,
		SingleValuedNonLinearOptimizer
	)

Run-time type information (and related methods).

FREE::ES::EvolutionaryStrategyOptimizerBase::itkSetMacro	(	MaximumIteration	,
		unsigned	int
	)

Set/Get maximum iteration limit.

FREE::ES::EvolutionaryStrategyOptimizerBase::itkGetConstReferenceMacro	(	MaximumIteration	,
		unsigned	int
	)

FREE::ES::EvolutionaryStrategyOptimizerBase::itkGetConstReferenceMacro	(	CurrentCost	,
		MeasureType
	)

Return Current Value

MeasureType FREE::ES::EvolutionaryStrategyOptimizerBase::GetValue

(

)

const [inline]

Definition at line 64 of file freEvolutionaryStrategyOptimizerBase.h.

Referenced by FREE::EvolutionaryStrategyOptimizerController::GetCurrentValue().

FREE::ES::EvolutionaryStrategyOptimizerBase::itkGetConstReferenceMacro	(	CurrentIteration	,
		unsigned	int
	)

Return Current Iteration

FREE::ES::EvolutionaryStrategyOptimizerBase::itkSetMacro	(	Maximize	,
		bool
	)

Specify whether to minimize or maximize the cost function.

FREE::ES::EvolutionaryStrategyOptimizerBase::itkGetConstMacro	(	Maximize	,
		bool
	)

FREE::ES::EvolutionaryStrategyOptimizerBase::itkBooleanMacro

(

Maximize

)

bool FREE::ES::EvolutionaryStrategyOptimizerBase::GetMinimize

(

)

const [inline]

Definition at line 73 of file freEvolutionaryStrategyOptimizerBase.h.

Referenced by FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::FindBestIndividual(), and FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::SetBestIndividual().

void FREE::ES::EvolutionaryStrategyOptimizerBase::SetMinimize

(

bool

v

)

[inline]

Definition at line 75 of file freEvolutionaryStrategyOptimizerBase.h.

void FREE::ES::EvolutionaryStrategyOptimizerBase::MinimizeOn

(

void

)

[inline]

Definition at line 77 of file freEvolutionaryStrategyOptimizerBase.h.

void FREE::ES::EvolutionaryStrategyOptimizerBase::MinimizeOff

(

void

)

[inline]

Definition at line 79 of file freEvolutionaryStrategyOptimizerBase.h.

virtual void FREE::ES::EvolutionaryStrategyOptimizerBase::StartOptimization

(

)

[pure virtual]

Start optimization. Optimization will stop when it meets either of two termination conditions, the maximum iteration limit or epsilon (minimal search radius)

Implemented in FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >.

virtual void FREE::ES::EvolutionaryStrategyOptimizerBase::StopOptimization

(

)

[inline, virtual]

when users call StartOptimization, this value will be set false. By calling StopOptimization, this flag will be set true, and optimization will stop at the next iteration.

Definition at line 90 of file freEvolutionaryStrategyOptimizerBase.h.

void FREE::ES::EvolutionaryStrategyOptimizerBase::ResumeOptimization

(

)

[virtual]

Resumes the optimization. You have to call StartOptimization befor you can resume it. Calling this method without StartOptimizazion will cause an exception.

Reimplemented in FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >.

Definition at line 61 of file freEvolutionaryStrategyOptimizerBase.cxx.

Referenced by FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::ResumeOptimization().

void FREE::ES::EvolutionaryStrategyOptimizerBase::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)			const [protected]

Reimplemented in FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >.

Definition at line 49 of file freEvolutionaryStrategyOptimizerBase.cxx.

Referenced by FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::PrintSelf().

---

Member Data Documentation

bool FREE::ES::EvolutionaryStrategyOptimizerBase::m_Stop [protected]

This is user-settable flag to stop optimization. when users call StartOptimization, this value will be set false. By calling StopOptimization, this flag will be set true, and optimization will stop at the next iteration.

Definition at line 109 of file freEvolutionaryStrategyOptimizerBase.h.

Referenced by FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::ResumeOptimization(), and FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::StartOptimization().

bool FREE::ES::EvolutionaryStrategyOptimizerBase::m_Started [protected]

Indicates of the optimization has started by calling StartOptimization. Needed to determine if ResumeOptimization can be called

Definition at line 114 of file freEvolutionaryStrategyOptimizerBase.h.

Referenced by FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::ResumeOptimization(), and FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::StartOptimization().

unsigned int FREE::ES::EvolutionaryStrategyOptimizerBase::m_CurrentIteration [protected]

Current iteration

Definition at line 117 of file freEvolutionaryStrategyOptimizerBase.h.

Referenced by FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::ResumeOptimization(), and FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::StartOptimization().

MeasureType FREE::ES::EvolutionaryStrategyOptimizerBase::m_CurrentCost [protected]

Internal storage for the value type / used as a cache

Definition at line 120 of file freEvolutionaryStrategyOptimizerBase.h.

Referenced by FREE::ES::EvolutionaryStrategyOptimizer< TIndividual >::ResumeOptimization().

unsigned int FREE::ES::EvolutionaryStrategyOptimizerBase::m_MaximumIteration [private]

Maximum iteration limit.

Definition at line 124 of file freEvolutionaryStrategyOptimizerBase.h.

bool FREE::ES::EvolutionaryStrategyOptimizerBase::m_Maximize [private]

Definition at line 126 of file freEvolutionaryStrategyOptimizerBase.h.

---

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

• freEvolutionaryStrategyOptimizerBase.h
• freEvolutionaryStrategyOptimizerBase.cxx

---