FREE::SPSASOOptimizerController Class Reference
[Optimizer controller, Setup optimization optimizer]

Derived class of a controller object for optimizers. More...

#include <freSPSASOOptimizerController.h>

Inheritance diagram for FREE::SPSASOOptimizerController:

[legend]

Collaboration diagram for FREE::SPSASOOptimizerController:

[legend]

List of all members.

Public Types
typedef SPSASOOptimizer	ComponentType
typedef SetupOptimizationOptimizerControllerBase < ComponentType >	Superclass
Public Member Functions
	itkTypeMacro (SPSASOOptimizerController, SetupOptimizationOptimizerControllerBase)
	DeclareParameterMacro (ValueUpdateRate)
	DeclareParameterMacro (MinimumNumberOfIteration)
	DeclareParameterMacro (MaximumNumberOfIteration)
	DeclareParameterMacro (a)
	DeclareParameterMacro (A)
	DeclareParameterMacro (c)
	DeclareParameterMacro (Alpha)
	DeclareParameterMacro (Gamma)
	DeclareParameterMacro (NumberOfPertubations)
	DeclareParameterMacro (ConvergenceDecayRate)
	DeclareParameterMacro (Tolerance)
	DeclareParameterMacro (GuessParameters)
	DeclareParameterMacro (Guess_GradientEstimates)
	DeclareParameterMacro (Guess_InitialStepSize)
virtual long	GetMaxIterationCount (const SessionComponentCache *pComponentCache, unsigned int iResolutionLevel=0) const
	SPSASOOptimizerController ()
Protected Member Functions
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
virtual void	ActualizeMainComponent (ComponentType *pMainComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, const unsigned int &iActLevel) const
virtual void	SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType *pMainComponent, SessionComponentCache *pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const
virtual void	ActualizeFinalization (ComponentType *pMainComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, const unsigned int &iActLevel) const

---

Detailed Description

Derived class of a controller object for optimizers.

Definition at line 38 of file freSPSASOOptimizerController.h.

---

Member Typedef Documentation

typedef SPSASOOptimizer FREE::SPSASOOptimizerController::ComponentType

The component class managed by the controller. The component class must be a derivation from itk::LightObject to ensure the ability to use the smartpointer concept of itk

Reimplemented from FREE::SetupOptimizationOptimizerControllerBase< TControlledOptimizer >.

Definition at line 58 of file freSPSASOOptimizerController.h.

typedef SetupOptimizationOptimizerControllerBase<ComponentType> FREE::SPSASOOptimizerController::Superclass

Reimplemented from FREE::SetupOptimizationOptimizerControllerBase< TControlledOptimizer >.

Definition at line 59 of file freSPSASOOptimizerController.h.

---

Constructor & Destructor Documentation

FREE::SPSASOOptimizerController::SPSASOOptimizerController

(

)

Definition at line 52 of file freSPSASOOptimizerController.cxx.

References FREE::ComponentControllerInterface::m_Description, and FREE::ComponentControllerInterface::UpdateControllerID().

Here is the call graph for this function:

---

Member Function Documentation

FREE::SPSASOOptimizerController::itkTypeMacro	(	SPSASOOptimizerController	,
		SetupOptimizationOptimizerControllerBase
	)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

ValueUpdateRate

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

MinimumNumberOfIteration

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

MaximumNumberOfIteration

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

a

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

A

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

c

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

Alpha

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

Gamma

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

NumberOfPertubations

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

ConvergenceDecayRate

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

Tolerance

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

GuessParameters

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

Guess_GradientEstimates

)

FREE::SPSASOOptimizerController::DeclareParameterMacro

(

Guess_InitialStepSize

)

long FREE::SPSASOOptimizerController::GetMaxIterationCount	(	const SessionComponentCache *	pComponentCache,
		unsigned int	iResolutionLevel = 0
	)			const [virtual]

Returns the maximum number of iteration steps of the passed resolution level. The return of the function depends on the derived classes. If the return -1 the count is unknown (e.g optimizer has only a threshold value as stopping criterion)

Reimplemented from FREE::OptimizerControllerBase< TControlledOptimizer >.

Definition at line 86 of file freSPSASOOptimizerController.cxx.

References catchAllNPassMacro, FREE::cParam_Iterations, FREE::SessionAccessor::GetParameterValue(), FREE::SessionComponentCache::SetupIsAssigned(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

void FREE::SPSASOOptimizerController::GenerateProfile	(	CtrlProfile::ControllerProfile &	profile,
		const SessionComponentCache *	pComponentCache,
		bool	bRegardOldSetup
	)			const [protected, virtual]

Adjusts the current profile according to the definitions of the controller.
Method should call the superclass variant to regard demands of basic controllers.

Parameters:

[in,out]	profile	Reference of the current profile.
[in]	pComponentCache	Pointer to the cache indicating the location of the component that should be profiled. This pointer can be null. In this case only a default profile that isn't context sensitive is wanted (others aren't possible anyway)
[in]	bRegardOldSetup	If true, the setup of pComponentCache is valid and should be regarded when the profile is generated. Otherwise just use defaults if setup information is needed.

Reimplemented from FREE::SetupOptimizationOptimizerControllerBase< TControlledOptimizer >.

Definition at line 61 of file freSPSASOOptimizerController.cxx.

References FREE::ComponentControllerBase< TControlledOptimizer >::GenerateProfile(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), FREE::Parameter::PVTBool, FREE::Parameter::PVTDouble, FREE::Parameter::PVTLong, and FREE::Parameter::PVTULong.

Here is the call graph for this function:

void FREE::SPSASOOptimizerController::ActualizeMainComponent	(	ComponentType *	pMainComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo,
		const unsigned int &	iActLevel
	)			const [protected, virtual]

Definition at line 103 of file freSPSASOOptimizerController.cxx.

References FREE::ComponentControllerBase< TControlledOptimizer >::ActualizeMainComponent(), catchAllNPassMacro, FREE::cComp_MainMetric, FREE::cIDPParent, FREE::cParam_MetricMinimize, FREE::SessionAccessor::GetParameterByIDPath(), and FREE::SessionAccessor::GetParameterValue().

Here is the call graph for this function:

void FREE::SPSASOOptimizerController::SetStatisticEntryMainComponent	(	StatisticEntry &	rStatisticEntry,
		ComponentType *	pMainComponent,
		SessionComponentCache *	pMainComponentCache,
		SessionInfo *	pSessionInfo,
		StatisticDictionary &	rDictionary
	)			const [protected, virtual]

Definition at line 162 of file freSPSASOOptimizerController.cxx.

References FREE::StatisticEntry::AddValue(), FREE::StatisticDictionary::AddValueDefinition(), FREE::SessionComponentCache::GetIDPath(), FREE::StatisticValueDefinition::GetRefID(), FREE::StatisticDictionary::GetValueDefinitionByName(), and FREE::Convert::ToStr().

Here is the call graph for this function:

void FREE::SPSASOOptimizerController::ActualizeFinalization	(	ComponentType *	pMainComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo,
		const unsigned int &	iActLevel
	)			const [protected, virtual]

Definition at line 202 of file freSPSASOOptimizerController.cxx.

References catchAllNPassMacro, FREE::SessionAccessor::GetParameterValue(), FREE::SessionComponentCache::Setup(), FREE::SessionComponentCache::SetupIsAssigned(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

---

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

• freSPSASOOptimizerController.h
• freSPSASOOptimizerController.cxx

---