#include <CapeNLPParameter.hpp>
Public Member Functions | |
| virtual | ~ICapeOptimizationPoint () |
| virtual Common::Types::CapeLong | Content () const =0 |
| virtual Common::Types::CapeBoolean | Content (eCapeOptPointEntry entryType) const =0 |
| virtual Common::Types::CapeValidationStatus | ValStatus (eCapeOptPointEntry entryType) const =0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) |
| virtual Common::Types::CapeLong | ValStatus () const =0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) |
| virtual Common::Types::CapeVariant | GetParameterValue (Common::Types::CapeLong _idx) const =0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) |
| virtual Common::Parameter::ICapeParameterSpec * | GetParameterSpec (Common::Types::CapeLong _idx) const =0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) |
| virtual Common::Types::CapeLong | GetParametersCount () const =0 |
| virtual Common::Types::CapeDouble | GetObjFunction () const =0 |
| virtual void | Reinitialize ()=0 throw (Common::Error::ECapeUnknown) |
| virtual Common::Types::CapeValidationStatus | Update ()=0 throw (Common::Error::ECapeUnknown) |
Friends | |
| std::ostream & | operator<< (std::ostream &out_file, const ICapeOptimizationPoint &) |
Detailed Description
Represents an interface for description of objective function's behaviour in the given point.
Constructor & Destructor Documentation
| virtual ~ICapeOptimizationPoint | ( | ) | [inline, virtual] |
Virtual default destructor.
Member Function Documentation
| virtual Common::Types::CapeLong Content | ( | ) | const [pure 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.
Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.
| virtual Common::Types::CapeBoolean Content | ( | eCapeOptPointEntry | entryType | ) | const [pure 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.
Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.
| virtual Common::Types::CapeDouble GetObjFunction | ( | ) | const [pure virtual] |
Gets value of objactive fonction in point.
Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.
| virtual Common::Types::CapeLong GetParametersCount | ( | ) | const [pure virtual] |
Gets count of parameters in the list.
Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.
| virtual Common::Parameter::ICapeParameterSpec* GetParameterSpec | ( | Common::Types::CapeLong | _idx | ) | const throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [pure virtual] |
Gets parameter's specification.
Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.
| virtual Common::Types::CapeVariant GetParameterValue | ( | Common::Types::CapeLong | _idx | ) | const throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [pure virtual] |
Gets parameter value with index specified.
Implemented in DianaSensNLPTaskParametersList, and DianaNLPTaskParametersList.
| virtual void Reinitialize | ( | ) | throw (Common::Error::ECapeUnknown) [pure virtual] |
Replaces values of ICapeOptimizationPoint parameters by values of saved into task's sought parameters.
Implemented in DianaSensNLPTaskParametersList, DianaSensOptimizationPoint, and DianaOptimizationPoint.
| virtual Common::Types::CapeValidationStatus Update | ( | ) | throw (Common::Error::ECapeUnknown) [pure virtual] |
Replaces values of task's sought parameters by values of saved into ICapeOptimizationPoint parameters.
Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.
| virtual Common::Types::CapeValidationStatus ValStatus | ( | eCapeOptPointEntry | entryType | ) | const throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [pure 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.
Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.
| virtual Common::Types::CapeLong ValStatus | ( | ) | const throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [pure 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.
Implemented in DianaSensOptimizationPoint, and DianaOptimizationPoint.
Friends And Related Function Documentation
| std::ostream& operator<< | ( | std::ostream & | out_file, |
| const ICapeOptimizationPoint & | |||
| ) | [friend] |
ostream output operator for the ICapeNumericLASolver class.
The documentation for this class was generated from the following file:
