DianaNLPTask.hpp

#ifndef DIANA_NLP_TASK_HPP
#define DIANA_NLP_TASK_HPP

#include <CapeOpen.hpp>

#include <Diana/IDianaMain.hpp>
#include <Diana/DianaParameter.hpp>
#include <Diana/DianaModel.hpp>
#include <Diana/IDianaDAESO.hpp>
#include <Diana/DianaSensDAESO.hpp>
#include <Diana/IDianaReporting.hpp>

#include <math.h>
#include <iostream>
#include <sstream>
#include <stdarg.h>
#include <fstream>

using namespace std;
using namespace Diana;
using namespace Common::Types;
using namespace Common::Collection;
using namespace Numeric::Solvers::Eso;
using namespace Numeric::Solvers::Model;
using namespace Numeric::Solvers::Solver;
using namespace Common::NLPData;

namespace Numeric {
  namespace Solvers {
    namespace NLPTasks {


      // Forward declaration of interfaces
      class IDianaNLPTaskReporting;

      /* Interface for task classes supporting task reports building */
      class IDianaNLPTaskReporting {
      public:
        virtual void Output(Diana::SolverEvents event) = 0;
      };

      typedef CapeDouble (*evalfunc)(Numeric::Solvers::NLPTasks::ICapeNLPTask& task);

      class CFunction : public Numeric::Solvers::NLPTasks::ICapeNLPFunction {
      public:
        CFunction(evalfunc f);

        inline CapeDouble Exec(Numeric::Solvers::NLPTasks::ICapeNLPTask& task) 
          throw (Common::Error::ECapeSolvingError) { return pCFunc(task); }

        virtual const Common::Types::CapeString& GetComponentName() const
          throw (Common::Error::ECapeUnknown);

        virtual void SetComponentName(const Common::Types::CapeString& _name)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

        virtual const Common::Types::CapeString& GetComponentDescription() const
          throw (Common::Error::ECapeUnknown);

        virtual void SetComponentDescription(const Common::Types::CapeString& _description)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

#ifndef SWIG

        virtual ICapeIdentification* clone()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl);
#endif
      private:
        evalfunc pCFunc;        

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

      enum DerivativeApproximationType {
        daForwardDifference = 0,
        daCentralDifference,
        daFourthCentralDifference
      };

      class DianaNLPTask : virtual public Numeric::Solvers::NLPTasks::ICapeNLPTask {
      public:
        virtual ~DianaNLPTask();

        inline const Common::Collection::ICapeCollection& GetSoughtParameters() const
          throw(Common::Error::ECapeUnknown) { return soughtParams; }

        virtual ConstraintFuncArray* GetConstraintFuncList(ConstraintType _type) 
          throw(Common::Error::ECapeUnknown);

        virtual void SetNLPParameters(Parameters::ICapeOptimizationPoint* _pars) 
          throw(Common::Error::ECapeUnknown) { fitParams = _pars; }

        const Parameters::ICapeOptimizationPoint& GetNLPParameters() 
          throw(Common::Error::ECapeUnknown) { return *fitParams; }

        virtual void AddConstraintFunc(ICapeNLPFunction *_func, ConstraintType _type) 
          throw(Common::Error::ECapeUnknown);

        virtual Common::Types::CapeArrayDouble CalcConstraints(ConstraintType _type)
          throw(Common::Error::ECapeUnknown);

        virtual Common::Types::CapeDouble CalcConstraint(Common::Types::CapeLong _index, ConstraintType _type)
          throw(Common::Error::ECapeUnknown);

        virtual Common::Types::CapeShort GetConstraintsCount(ConstraintType type) const
          throw(Common::Error::ECapeUnknown);

        virtual void SetSimulationContext(Common::Identification::ICapeIdentification* simContextManager)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl) {}

        virtual void Initialize()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation,
                 Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError,
                 Common::Error::ECapeBadInvOrder) {}

        virtual void Terminate()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources,
                 Common::Error::ECapeBadInvOrder) {}

        inline Common::Collection::ICapeCollection* GetParameters() 
          throw(Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation,
                Common::Error::ECapeNoImpl) { 
          return &this->collParameters; 
        }

        virtual void SetComponentName(const Common::Types::CapeString& _name)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

        virtual void SetComponentDescription(const Common::Types::CapeString& _description)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

        virtual void UpdateNLPParameters()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

        virtual void UpdateOptimizationPoint()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

        void SetReportingInterface(Diana::IDianaReporting* _pReportingInterface)
          throw (Common::Error::ECapeUnknown);

        void RemoveReportingInterface(Diana::IDianaReporting* _pReportingInterface)
          throw (Common::Error::ECapeUnknown);

      protected:
#ifndef SWIG 

        inline void AddSoughtParameter(const Common::Parameter::ICapeParameter* parParameter) {
          soughtParams.AddIndexed(new DianaParameter(dynamic_cast<const Diana::DianaParameter&>
                                                     (*parParameter)));
        }

        void AddParametersSpec(const Common::Parameter::CapeArrayParameterSpec &_parspecs) 
          throw(Common::Error::ECapeInvalidArgument);

        void notifyEventHandlers(NLPTaskEvents event) 
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, 
                 Common::Error::ECapeFailedInitialisation);

        bool areEventHandlers();
#endif
      protected:
        Diana::DianaCollection collParameters;                  

        ConstraintFuncArray constrainsGx;                       
        ConstraintFuncArray constrainsHx;                       
        Diana::DianaCollection soughtParams;                    
        Parameters::ICapeOptimizationPoint* fitParams;          

      private:
        std::vector<Diana::IDianaReporting*>  arrReportingInterfaces; 
      };


      class ICapeNLPTest : public Common::Identification::ICapeIdentification {
      public:
        ICapeNLPTest(Diana::IDianaMain* _dmain) : parcount(2), dmain(_dmain) {};

        virtual ~ICapeNLPTest();

        virtual ICapeNLPTask* getCapeNLPTask() = 0;

        inline void SetParameterCount(int _parcount) { parcount = _parcount; };

        virtual const Common::Types::CapeString& GetComponentName() const
          throw (Common::Error::ECapeUnknown);

        virtual void SetComponentName(const Common::Types::CapeString& _name)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

        virtual const Common::Types::CapeString& GetComponentDescription() const
          throw (Common::Error::ECapeUnknown);

        virtual void SetComponentDescription(const Common::Types::CapeString& _description)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);
      protected:
        CapeArrayNLPTask tasks;         
        int parcount;                   
        IDianaMain* dmain;              
      };

    }
  }
}

#endif // DIANA_NLP_TASK_HPP