#include <DianaNLPParameter.hpp>
Detailed Description
Represents Diana's interface for description of objective function's behaviour in the given point.
Constructor & Destructor Documentation
| DianaOptimizationPoint | ( | const Common::Collection::ICapeCollection & | collSoughtParamsVals | ) |
Constructor of DianaOptimizationPoint class.
| virtual ~DianaOptimizationPoint | ( | ) | [inline, virtual] |
Destructor of DianaOptimizationPoint 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_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_OBJFUNC.
| const Common::Types::CapeString& GetComponentDescription | ( | ) | const throw (Common::Error::ECapeUnknown) [inline, virtual] |
gets the description of the component.
Implements ICapeIdentification.
References DianaOptimizationPoint::strDescription.
| const Common::Types::CapeString& GetComponentName | ( | ) | const throw (Common::Error::ECapeUnknown) [inline, virtual] |
gets the name of the component.
Implements ICapeIdentification.
References DianaOptimizationPoint::strName.
| const Common::Types::CapeArrayDouble& GetConstraintValues | ( | Numeric::Solvers::NLPTasks::ConstraintType | _type | ) | const [inline] |
Gets constrant's values of objactive fonction in point.
References DianaOptimizationPoint::arrGxConstr, DianaOptimizationPoint::arrHxConstr, and Numeric::Solvers::NLPTasks::ctGx.
| Common::Types::CapeDouble GetObjFunction | ( | ) | const [virtual] |
Gets value of objactive fonction in point.
Implements ICapeOptimizationPoint.
| virtual Common::Types::CapeLong GetParametersCount | ( | ) | const [inline, virtual] |
Gets count of parameters in the list.
Implements ICapeOptimizationPoint.
References DianaOptimizationPoint::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 DianaOptimizationPoint::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, DianaOptimizationPoint::vsGxConstr, DianaOptimizationPoint::vsHxConstr, and DianaOptimizationPoint::vsObjFunc.
| 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 DianaOptimizationPoint::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 DianaNLPTaskParametersList.
| 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 DianaOptimizationPoint::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.
| 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 DianaOptimizationPoint::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 DianaOptimizationPoint::strName.
| void SetConstraintValues | ( | Numeric::Solvers::NLPTasks::ConstraintType | _type, |
| Common::Types::CapeArrayDouble | _arrConstr, | ||
| Common::Types::CapeValidationStatus | _vsConstr = Common::Types::CAPE_VALID |
||
| ) |
Sets constrant's values for the current parameter's list.
| 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 DianaOptimizationPoint::dblObjFunc, and DianaOptimizationPoint::vsObjFunc.
| virtual Common::Types::CapeValidationStatus Update | ( | ) | throw (Common::Error::ECapeUnknown) [virtual] |
Replaces values of task's sought parameters by values of saved into ICapeOptimizationPoint parameters.
Implements ICapeOptimizationPoint.
| Common::Types::CapeValidationStatus ValStatus | ( | Numeric::Solvers::NLPTasks::eCapeOptPointEntry | entryType | ) | const throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [inline, 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.
References Numeric::Solvers::NLPTasks::CAPE_OBJFUNC, Common::Error::ECodeNone, and DianaOptimizationPoint::vsObjFunc.
| Common::Types::CapeLong ValStatus | ( | ) | const throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [inline, virtual] |
Gets the set of 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_OBJFUNC, Common::Types::CAPE_VALID, and DianaOptimizationPoint::vsObjFunc.
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 DianaOptimizationPoint::MarkAsInvalid(), DianaOptimizationPoint::SetObjFunction(), and DianaOptimizationPoint::ValStatus().
The documentation for this class was generated from the following file:
