DianaNLPParameter.hpp

#ifndef DIANA_NLP_PARAMETER_H
#define DIANA_NLP_PARAMETER_H

#include <CapeOpen.hpp>
#include "DianaParameter.hpp"

namespace Diana {
  //     // forward declaration
  //     class DianaNLPTaskParametersList;
  //     class DianaSensNLPTaskParametersList;

  class IDianaOptimizationPoint : virtual public Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint {
  public:
    virtual ~IDianaOptimizationPoint(){}

    virtual void SetParameter(Common::Types::CapeLong _idx, Common::Types::CapeVariant _value)
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) = 0;


#ifndef SWIG

    virtual Common::Types::CapeBoolean operator == (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& parVal) const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeData) = 0;

    virtual Common::Types::CapeBoolean operator != (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& parVal) const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeData) = 0;

    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)
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) = 0;
#endif

    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:
    //     /** 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.
    //      *  \param value the value of the parameter to validate */
    //     virtual Common::Types::CapeBoolean Validate()
    //         throw(Common::Error::ECapeUnknown,
    //                Common::Error::ECapeInvalidArgument) = 0;

    virtual void MarkAsInvalid() = 0;
  };

  class IDianaSensOptimizationPoint : virtual public IDianaOptimizationPoint, virtual public Numeric::Solvers::NLPTasks::Parameters::ICapeSensOptimizationPoint {
  public:
    virtual ~IDianaSensOptimizationPoint(){}

    virtual void SetGradient(const Common::Types::CapeArrayDouble& _value, Common::Types::CapeValidationStatus _vsObjFunc = Common::Types::CAPE_VALID) = 0;

  protected:;
  };

  class DianaOptimizationPoint : virtual public IDianaOptimizationPoint {
  public:
    DianaOptimizationPoint(const Common::Collection::ICapeCollection& collSoughtParamsVals);
  
    virtual ~DianaOptimizationPoint () {}

    inline Common::Types::CapeLong Content() const { return Numeric::Solvers::NLPTasks::CAPE_OBJFUNC; }

    inline Common::Types::CapeBoolean Content(Numeric::Solvers::NLPTasks::eCapeOptPointEntry entryType) const {
      return (entryType == Numeric::Solvers::NLPTasks::CAPE_OBJFUNC);
    }

    inline Common::Types::CapeValidationStatus ValStatus(Numeric::Solvers::NLPTasks::eCapeOptPointEntry entryType) const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) {
      if(entryType == Numeric::Solvers::NLPTasks::CAPE_OBJFUNC)
        return this->vsObjFunc;
      else throw Common::Error::ECapeInvalidArgument(Common::Error::ECodeNone, "unsupported by optimization point type of entry", 
                                                     "Diana", "DianaOptimizationPoint", "ValStatus", "");
    }

    inline Common::Types::CapeLong ValStatus() const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) {
      return (this->vsObjFunc == Common::Types::CAPE_VALID) ? Numeric::Solvers::NLPTasks::CAPE_OBJFUNC : 0;
    }

    Common::Types::CapeDouble GetObjFunction() 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);

    inline virtual Common::Types::CapeLong GetParametersCount() const {
      return this->collParams->Count();
    }

#ifndef SWIG

    virtual Common::Types::CapeBoolean operator == (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& parVal) const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeData);

    inline virtual Common::Types::CapeBoolean operator != (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& parVal) const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeData) { 
      return !(this->operator == (parVal)); 
    }

    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) {}// = 0;
#endif

    const Common::Types::CapeString& GetComponentName() const
      throw(Common::Error::ECapeUnknown) {
      return this->strName;
    }

    void SetComponentName(const Common::Types::CapeString& _name)
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) {
      this->strName = _name;
    }

    const Common::Types::CapeString& GetComponentDescription() const
      throw(Common::Error::ECapeUnknown) {
      return this->strDescription;
    }

    void SetComponentDescription(const Common::Types::CapeString& _description)
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) {
      this->strDescription = _description;
    }

    inline void SetObjFunction(Common::Types::CapeDouble _dblObjFunc, Common::Types::CapeValidationStatus _vsObjFunc = Common::Types::CAPE_VALID) {
      this->dblObjFunc = _dblObjFunc; this->vsObjFunc = _vsObjFunc;
    }

    inline const Common::Collection::ICapeCollection* GetTasksParameters() const {
      return this->collParams;
    }

    inline const Common::Types::CapeArrayDouble& GetConstraintValues(Numeric::Solvers::NLPTasks::ConstraintType _type) const {
      return (_type == Numeric::Solvers::NLPTasks::ctGx) ? arrGxConstr : arrHxConstr;
    }

    void SetConstraintValues(Numeric::Solvers::NLPTasks::ConstraintType _type, Common::Types::CapeArrayDouble _arrConstr, Common::Types::CapeValidationStatus _vsConstr = Common::Types::CAPE_VALID);

  protected:
    inline void MarkAsInvalid() {
      this->vsObjFunc = Common::Types::CAPE_NOT_VALIDATED;
      this->vsGxConstr = Common::Types::CAPE_NOT_VALIDATED;
      this->vsHxConstr = Common::Types::CAPE_NOT_VALIDATED;
    }

  protected:
    const Common::Collection::ICapeCollection* collParams;      

    Common::Types::CapeValidationStatus vsObjFunc;              

    Common::Types::CapeDouble dblObjFunc;                       

    Common::Types::CapeValidationStatus vsGxConstr;             
    Common::Types::CapeArrayDouble      arrGxConstr;            

    Common::Types::CapeValidationStatus vsHxConstr;             
    Common::Types::CapeArrayDouble      arrHxConstr;            

    Common::Types::CapeString strName;                          
    Common::Types::CapeString strDescription;                   
  };

  class DianaSensOptimizationPoint : virtual public IDianaSensOptimizationPoint {
  public:
    DianaSensOptimizationPoint(const Common::Collection::ICapeCollection& collSoughtParamsVals);
  
    virtual ~DianaSensOptimizationPoint () {}

    inline Common::Types::CapeLong Content() const { 
      return (Numeric::Solvers::NLPTasks::CAPE_OBJFUNC | Numeric::Solvers::NLPTasks::CAPE_GRADIENT | Numeric::Solvers::NLPTasks::CAPE_GXCONSTR | Numeric::Solvers::NLPTasks::CAPE_HXCONSTR); 
    }

    inline Common::Types::CapeBoolean Content(Numeric::Solvers::NLPTasks::eCapeOptPointEntry entryType) const {
      return ((entryType == Numeric::Solvers::NLPTasks::CAPE_OBJFUNC) || (entryType == Numeric::Solvers::NLPTasks::CAPE_GRADIENT));
    }

    Common::Types::CapeValidationStatus ValStatus(Numeric::Solvers::NLPTasks::eCapeOptPointEntry entryType) const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl);

    inline Common::Types::CapeLong ValStatus() const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) {
      return (((this->vsObjFunc == Common::Types::CAPE_VALID) ? Numeric::Solvers::NLPTasks::CAPE_OBJFUNC : 0) |
              ((this->vsObjFuncGradient == Common::Types::CAPE_VALID) ? Numeric::Solvers::NLPTasks::CAPE_GRADIENT : 0));
    }

    inline Common::Types::CapeDouble GetObjFunction() const {
      return (this->vsObjFunc == Common::Types::CAPE_VALID) ? this->dblObjFunc : Common::Types::CapeDoubleUNDEFINED;
    }

    inline const Common::Types::CapeArrayDouble& GetGradient() const {
      return arrObjFuncGradient;
    }

    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);

    inline virtual Common::Types::CapeLong GetParametersCount() const {
      return this->collParams->Count();
    }

#ifndef SWIG

    virtual Common::Types::CapeBoolean operator == (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& parVal) const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeData);

    inline virtual Common::Types::CapeBoolean operator != (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& parVal) const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeData) { return !(this->operator == (parVal)); }

    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) {}// = 0;
#endif

    const Common::Types::CapeString& GetComponentName() const
      throw(Common::Error::ECapeUnknown) {
      return this->strName;
    }

    void SetComponentName(const Common::Types::CapeString& _name)
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) {
      this->strName = _name;
    }

    const Common::Types::CapeString& GetComponentDescription() const
      throw(Common::Error::ECapeUnknown) {
      return this->strDescription;
    }

    void SetComponentDescription(const Common::Types::CapeString& _description)
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) {
      this->strDescription = _description;
    }

    inline void SetObjFunction(Common::Types::CapeDouble _dblObjFunc, Common::Types::CapeValidationStatus _vsObjFunc = Common::Types::CAPE_VALID) {
      this->dblObjFunc = _dblObjFunc; this->vsObjFunc = _vsObjFunc;
    }

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

    inline const Common::Collection::ICapeCollection* GetTasksParameters() const {
      return this->collParams;
    }

  protected:
    inline void MarkAsInvalid() {
      this->vsObjFunc = Common::Types::CAPE_NOT_VALIDATED;
      this->vsObjFuncGradient = Common::Types::CAPE_NOT_VALIDATED;
    }

  protected:
    const Common::Collection::ICapeCollection* collParams;      

    Common::Types::CapeValidationStatus vsObjFunc;              

    Common::Types::CapeDouble dblObjFunc;                       

    Common::Types::CapeValidationStatus vsObjFuncGradient;      

    Common::Types::CapeArrayDouble arrObjFuncGradient;          

    Common::Types::CapeString strName;                          
    Common::Types::CapeString strDescription;                   
  };

  class DianaNLPTaskParametersList : public DianaOptimizationPoint {
  public:
#ifndef SWIG

    explicit DianaNLPTaskParametersList(const Common::Collection::ICapeCollection& collSoughtParamsVals, 
                                        Common::Types::CapeBoolean bReinitialize = true);

    //     /**  Initialize class with specified double array. */
    //     DianaNLPTaskParametersList(Common::Types::CapeDouble *array, Common::Types::CapeLong size);
    
    DianaNLPTaskParametersList(const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& parList);
    DianaNLPTaskParametersList(CapeDouble *arr, CapeLong length, Numeric::Solvers::NLPTasks::ICapeNLPTask *task);
#endif

    DianaNLPTaskParametersList(const CapeArrayDouble &arr, Numeric::Solvers::NLPTasks::ICapeNLPTask *task);

    void SetParameter(Common::Types::CapeLong _idx, Common::Types::CapeVariant _value)
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl);

    Common::Types::CapeVariant GetParameterValue(Common::Types::CapeLong _idx) const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl);
    
#ifndef SWIG

    virtual void operator = (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& parList)
        throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

    inline ICapeIdentification* clone()
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) {
           return new DianaNLPTaskParametersList(*this);
    }
#endif
    
  private:
    Common::Types::CapeArrayVariant arrParamsValues;    
  };

  class DianaSensNLPTaskParametersList : public DianaSensOptimizationPoint {
  public:
    explicit DianaSensNLPTaskParametersList(const Common::Collection::ICapeCollection& collSoughtParamsVals, 
                                            Common::Types::CapeBoolean bReinitialize = true);

    DianaSensNLPTaskParametersList(const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& parList);

    void SetParameter(Common::Types::CapeLong _idx, Common::Types::CapeVariant _value)
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl);

    Common::Types::CapeVariant GetParameterValue(Common::Types::CapeLong _idx) const
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl);

#ifndef SWIG

    virtual void operator = (const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& parList)
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

    inline ICapeIdentification* clone()
      throw(Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) {
           return new DianaSensNLPTaskParametersList(*this);
    }
#endif

    virtual void Reinitialize()
      throw(Common::Error::ECapeUnknown);

  private:
    Common::Types::CapeArrayVariant arrParamsValues;    

    Common::Types::CapeString strName;                  
    Common::Types::CapeString strDescription;           
  };
}

#endif //DIANA_NLP_PARAMETER_H