DianaSensOptimizationPoint Class Reference

#include <DianaNLPParameter.hpp>

Inheritance diagram for DianaSensOptimizationPoint:

List of all members.

Public Member Functions
	DianaSensOptimizationPoint (const Common::Collection::ICapeCollection &collSoughtParamsVals)
virtual	~DianaSensOptimizationPoint ()
Common::Types::CapeLong	Content () const
Common::Types::CapeBoolean	Content (Numeric::Solvers::NLPTasks::eCapeOptPointEntry entryType) const
Common::Types::CapeValidationStatus	ValStatus (Numeric::Solvers::NLPTasks::eCapeOptPointEntry entryType) const throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl)
Common::Types::CapeLong	ValStatus () const throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
Common::Types::CapeDouble	GetObjFunction () const
const Common::Types::CapeArrayDouble &	GetGradient () const
virtual void	Reinitialize () throw (Common::Error::ECapeUnknown)
virtual Common::Types::CapeValidationStatus	Update () throw (Common::Error::ECapeUnknown)
virtual Common::Parameter::ICapeParameterSpec *	GetParameterSpec (Common::Types::CapeLong _idx) const throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl)
virtual Common::Types::CapeLong	GetParametersCount () const
virtual Common::Types::CapeBoolean	operator== (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &parVal) const throw (Common::Error::ECapeUnknown, Common::Error::ECapeData)
virtual Common::Types::CapeBoolean	operator!= (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &parVal) const throw (Common::Error::ECapeUnknown, Common::Error::ECapeData)
virtual Common::Types::CapeBoolean	operator< (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &parVal) const
virtual std::ostream &	operator<< (std::ostream &os) const
virtual void	operator= (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &parList) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
const Common::Types::CapeString &	GetComponentName () const throw (Common::Error::ECapeUnknown)
void	SetComponentName (const Common::Types::CapeString &_name) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
const Common::Types::CapeString &	GetComponentDescription () const throw (Common::Error::ECapeUnknown)
void	SetComponentDescription (const Common::Types::CapeString &_description) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
void	SetObjFunction (Common::Types::CapeDouble _dblObjFunc, Common::Types::CapeValidationStatus _vsObjFunc=Common::Types::CAPE_VALID)
virtual void	SetGradient (const Common::Types::CapeArrayDouble &_arrObjFuncGradient, Common::Types::CapeValidationStatus _vsObjFuncGradient=Common::Types::CAPE_VALID) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
const Common::Collection::ICapeCollection *	GetTasksParameters () const
Protected Member Functions
void	MarkAsInvalid ()
Protected Attributes
const Common::Collection::ICapeCollection *	collParams
	Collection of task's parameters.
Common::Types::CapeValidationStatus	vsObjFunc
Common::Types::CapeDouble	dblObjFunc
	Objective function's value for the current set of unknowns.
Common::Types::CapeValidationStatus	vsObjFuncGradient
Common::Types::CapeArrayDouble	arrObjFuncGradient
	Gradient's value for the current set of unknowns.
Common::Types::CapeString	strName
	Name of opt.point.
Common::Types::CapeString	strDescription
	Description of opt.point.

---

Detailed Description

Represents an interface for description of objective function's behaviour in the given point.

---

Constructor & Destructor Documentation

DianaSensOptimizationPoint

(

const Common::Collection::ICapeCollection &

collSoughtParamsVals

)

Constructor of DianaOptimizationPoint class.

virtual ~DianaSensOptimizationPoint

(

)

[inline, virtual]

Destructor of DianaSensOptimizationPoint class. It was made as pure virtual to properly destroy all derived classes using base pointer. TODO: Solve conflict. Use for VC++: virtual ~ICapeOptimizationPoint () = 0 {};

---

Member Function Documentation

Common::Types::CapeLong Content

(

)

const [inline, virtual]

Gets the set fo flags to indicate content of ICapeOptimizationPoint. It can contain objective function (CAPE_OBJFUNC), gredient (CAPE_GRADIENT), Jacobian of least squares (CAPE_LSJAC) and so on.

Implements ICapeOptimizationPoint.

References Numeric::Solvers::NLPTasks::CAPE_GRADIENT, Numeric::Solvers::NLPTasks::CAPE_GXCONSTR, Numeric::Solvers::NLPTasks::CAPE_HXCONSTR, and Numeric::Solvers::NLPTasks::CAPE_OBJFUNC.

Common::Types::CapeBoolean Content

(

Numeric::Solvers::NLPTasks::eCapeOptPointEntry

entryType

)

const [inline, virtual]

Gets the flag to indicate if given component (objective function (CAPE_OBJFUNC), gredient (CAPE_GRADIENT), Jacobian of least squares (CAPE_LSJAC) etc) belong to ICapeOptimizationPoint.

Implements ICapeOptimizationPoint.

References Numeric::Solvers::NLPTasks::CAPE_GRADIENT, and Numeric::Solvers::NLPTasks::CAPE_OBJFUNC.

const Common::Types::CapeString& GetComponentDescription

(

)

const throw (Common::Error::ECapeUnknown) [inline, virtual]

gets the description of the component.

Implements ICapeIdentification.

References DianaSensOptimizationPoint::strDescription.

const Common::Types::CapeString& GetComponentName

(

)

const throw (Common::Error::ECapeUnknown) [inline, virtual]

gets the name of the component.

Implements ICapeIdentification.

References DianaSensOptimizationPoint::strName.

const Common::Types::CapeArrayDouble& GetGradient

(

)

const [inline, virtual]

Gets gradient of objactive fonction in point.

Implements ICapeSensOptimizationPoint.

References DianaSensOptimizationPoint::arrObjFuncGradient.

Common::Types::CapeDouble GetObjFunction

(

)

const [inline, virtual]

Gets value of objactive fonction in point.

Implements ICapeOptimizationPoint.

References Common::Types::CAPE_VALID, Common::Types::CapeDoubleUNDEFINED, DianaSensOptimizationPoint::dblObjFunc, and DianaSensOptimizationPoint::vsObjFunc.

virtual Common::Types::CapeLong GetParametersCount

(

)

const [inline, virtual]

Gets count of parameters in the list.

Implements ICapeOptimizationPoint.

References DianaSensOptimizationPoint::collParams, and ICapeCollection::Count().

virtual Common::Parameter::ICapeParameterSpec* GetParameterSpec

(

Common::Types::CapeLong

_idx

)

const throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [virtual]

Gets parameter's specification.

Implements ICapeOptimizationPoint.

const Common::Collection::ICapeCollection* GetTasksParameters

(

)

const [inline, virtual]

Gets pointer on collection of task's parameters.

Implements IDianaOptimizationPoint.

References DianaSensOptimizationPoint::collParams.

void MarkAsInvalid

(

)

[inline, protected, virtual]

Marks all components of IDianaOptimizationPoint as not validated (CAPE_NOT_VALIDATED).

Implements IDianaOptimizationPoint.

References Common::Types::CAPE_NOT_VALIDATED, DianaSensOptimizationPoint::vsObjFunc, and DianaSensOptimizationPoint::vsObjFuncGradient.

virtual Common::Types::CapeBoolean operator!=

(

const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &

parVal

)

const throw (Common::Error::ECapeUnknown, Common::Error::ECapeData) [inline, virtual]

Compares this and given ICapeOptimizationPoint. For possibility of comparison classes ICapeOptimizationPoint have to base on the same collection of sought parameters. If there are compared values of NLP real parameetrs than precision of corresponding parameter keeps in mind.

Implements IDianaOptimizationPoint.

References DianaSensOptimizationPoint::operator==().

virtual Common::Types::CapeBoolean operator<

(

const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &

parVal

)

const [virtual]

Compares this and given ICapeOptimizationPoint. For possibility of comparison classes ICapeOptimizationPoint have to base on the same collection of sought parameters.

Implements IDianaOptimizationPoint.

virtual std::ostream& operator<<

(

std::ostream &

os

)

const [virtual]

Outputs parameter's data.

Implements IDianaOptimizationPoint.

virtual void operator=

(

const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &

parList

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [inline, virtual]

Copying operator. Copies state of another parameter.

Implements IDianaOptimizationPoint.

Reimplemented in DianaSensNLPTaskParametersList.

virtual Common::Types::CapeBoolean operator==

(

const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &

parVal

)

const throw (Common::Error::ECapeUnknown, Common::Error::ECapeData) [virtual]

Compares this and given ICapeOptimizationPoint. For possibility of comparison classes ICapeOptimizationPoint have to base on the same collection of sought parameters. If there are compared values of NLP real parameetrs than precision of corresponding parameter keeps in mind.

Implements IDianaOptimizationPoint.

Referenced by DianaSensOptimizationPoint::operator!=().

virtual void Reinitialize

(

)

throw (Common::Error::ECapeUnknown) [virtual]

Replaces values of ICapeOptimizationPoint parameters by values of saved into task's sought parameters.

Implements ICapeOptimizationPoint.

Reimplemented in DianaSensNLPTaskParametersList.

void SetComponentDescription

(

const Common::Types::CapeString &

_description

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [inline, virtual]

sets the description of the component.

Parameters:

_description

the description of the component

Implements ICapeIdentification.

References DianaSensOptimizationPoint::strDescription.

void SetComponentName

(

const Common::Types::CapeString &

_name

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [inline, virtual]

sets the name of the component.

Parameters:

_name

the name of the component

Implements ICapeIdentification.

References DianaSensOptimizationPoint::strName.

virtual void SetGradient	(	const Common::Types::CapeArrayDouble &	_arrObjFuncGradient,
		Common::Types::CapeValidationStatus	_vsObjFuncGradient = Common::Types::CAPE_VALID
	)		throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [virtual]

Sets gradient for given parameter's list.

Implements IDianaSensOptimizationPoint.

void SetObjFunction	(	Common::Types::CapeDouble	_dblObjFunc,
		Common::Types::CapeValidationStatus	_vsObjFunc = Common::Types::CAPE_VALID
	)		[inline, virtual]

Sets objective function value for the current parameter's list.

Implements IDianaOptimizationPoint.

References DianaSensOptimizationPoint::dblObjFunc, and DianaSensOptimizationPoint::vsObjFunc.

virtual Common::Types::CapeValidationStatus Update

(

)

throw (Common::Error::ECapeUnknown) [virtual]

Replaces values of task's sought parameters by values of saved in ICapeOptimizationPoint parameters into.

Implements ICapeOptimizationPoint.

Common::Types::CapeValidationStatus ValStatus

(

Numeric::Solvers::NLPTasks::eCapeOptPointEntry

entryType

)

const throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [virtual]

Gets the flag to indicate ICapeOptimizationPoint entry's validation status. It has three possible values:

• notValidated(CAPE_NOT_VALIDATED): its validate() method has not been called after the last time that its value had been changed.
• invalid(CAPE_INVALID): the last time that its validate() method was called it returned false.
• valid(CAPE_VALID): the last time that its validate() method was called it returned true.

Implements ICapeOptimizationPoint.

Common::Types::CapeLong ValStatus

(

)

const throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [inline, virtual]

Gets the set fo flags to indicate ICapeOptimizationPoint entries' validation status. The value of bit that corresponds to ICapeOptimizationPoint entry indicates:

• 0: 1. its validate() method has not been called after the last time that its value had been changed. 2. the last time that its validate() method was called it returned false.
• 1: the last time that its validate() method was called it returned true.

Implements ICapeOptimizationPoint.

References Numeric::Solvers::NLPTasks::CAPE_GRADIENT, Numeric::Solvers::NLPTasks::CAPE_OBJFUNC, Common::Types::CAPE_VALID, DianaSensOptimizationPoint::vsObjFunc, and DianaSensOptimizationPoint::vsObjFuncGradient.

---

Member Data Documentation

Common::Types::CapeValidationStatus vsObjFunc [protected]

Shows validness of objfunc value for the current set of unknowns. It is used to check the necessity of objective function's recalculation and also when task cannot calculate objfunc.

Referenced by DianaSensOptimizationPoint::GetObjFunction(), DianaSensOptimizationPoint::MarkAsInvalid(), DianaSensOptimizationPoint::SetObjFunction(), and DianaSensOptimizationPoint::ValStatus().

Common::Types::CapeValidationStatus vsObjFuncGradient [protected]

Shows validness of gradient's value for the current set of unknowns. It is used to check the necessity of gradient's recalculation and also when task cannot calculate gradient.

Referenced by DianaSensOptimizationPoint::MarkAsInvalid(), and DianaSensOptimizationPoint::ValStatus().

---

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

• DianaNLPParameter.hpp