Diana  0.8.3
Public Member Functions | Protected Member Functions
IDianaOptimizationPoint Class Reference

#include <DianaNLPParameter.hpp>

Inheritance diagram for IDianaOptimizationPoint:
ICapeOptimizationPoint ICapeIdentification DianaOptimizationPoint IDianaSensOptimizationPoint DianaNLPTaskParametersList DianaSensOptimizationPoint DianaSensNLPTaskParametersList

List of all members.

Public Member Functions

virtual ~IDianaOptimizationPoint ()
virtual void SetParameter (Common::Types::CapeLong _idx, Common::Types::CapeVariant _value)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl)
virtual Common::Types::CapeBoolean operator== (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &parVal) const =0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeData)
virtual Common::Types::CapeBoolean operator!= (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &parVal) const =0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeData)
virtual Common::Types::CapeBoolean operator< (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &parVal) const =0
virtual std::ostream & operator<< (std::ostream &os) const =0
virtual void operator= (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint &parList)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
virtual void SetObjFunction (Common::Types::CapeDouble _dblObjFunc, Common::Types::CapeValidationStatus _vsObjFunc=Common::Types::CAPE_VALID)=0
virtual const
Common::Collection::ICapeCollection
GetTasksParameters () const =0

Protected Member Functions

virtual void MarkAsInvalid ()=0

Detailed Description

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


Constructor & Destructor Documentation

virtual ~IDianaOptimizationPoint ( ) [inline, virtual]

Virtual default destructor.


Member Function Documentation

virtual const Common::Collection::ICapeCollection* GetTasksParameters ( ) const [pure virtual]

Gets pointer on collection of task's parameters.

Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.

virtual void MarkAsInvalid ( ) [protected, pure virtual]

Validates components of IDianaOptimizationPoint. It returns a flag to indicate the success or failure of the validation together. The flag is True for success and False for failure.

Parameters:
valuethe value of the parameter to validate Marks all components of IDianaOptimizationPoint as not validated (CAPE_NOT_VALIDATED).

Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.

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.

Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.

virtual Common::Types::CapeBoolean operator< ( const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint parVal) const [pure virtual]

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

Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.

virtual std::ostream& operator<< ( std::ostream &  os) const [pure virtual]

Outputs parameter's data.

Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.

Copying operator. Copies state of another parameter.

Implemented in DianaSensNLPTaskParametersList, DianaNLPTaskParametersList, DianaSensOptimizationPoint, and DianaOptimizationPoint.

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.

Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.

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

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

Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.

Sets the value of specified parameter. All derived classes must set ev_valid to false after setting parameters.

Implemented in DianaSensNLPTaskParametersList, and DianaNLPTaskParametersList.


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