DianaParameterFittingTask.hpp

#ifndef DIANA_PARAMETERFITTINGTASK_HPP
#define DIANA_PARAMETERFITTINGTASK_HPP

#include <CapeOpen.hpp>

#ifdef _MSC_VER
#include <direct.h>
#define popen _popen
#define pclose _pclose
#endif


namespace Numeric {
  namespace Solvers {
    namespace NLPTasks {

      // Forward declaration of interfaces
      class DianaParameterFittingTask;
      class ParameterFittingTask;
      class SensParameterFittingTask;
      class ParameterFittingTaskReport;


      typedef std::vector<DianaParameterFittingTask*> ArrayDianaParameterFittingTask;
      typedef std::vector<ParameterFittingTask*> ArrayParameterFittingTask;
      typedef std::vector<SensParameterFittingTask*> ArraySensParameterFittingTask;

      typedef std::vector<Common::Types::CapeArrayDouble> DianaNLPFullMatrixDouble;


      class IDianaSensitivityTaskCreator {
      public:
        virtual Numeric::Solvers::NLPTasks::ICapeNLPTask* GetSensitivityTask()
          throw(Common::Error::ECapeInvalidArgument, Common::Error::ECapeUnknown) = 0;
      };



      class DianaParameterFittingTask : public DianaDynamicNLPTask, virtual public IDianaNLPTaskReporting {
      public:

        DianaParameterFittingTask(const Common::NLPData::CapeMeasuredData* _expdata, 
                                  Numeric::Solvers::Solver::ICapeNumericSolver* _solver = NULL,
                                  Numeric::Solvers::Model::ICapeNumericContinuousModel* _model = NULL,
                                  IDianaMain* _dianaMain = NULL,
                                  CapeString _solverName = NULL);

        virtual ~DianaParameterFittingTask();

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

        inline const Common::NLPData::CapeMeasuredData* GetExpData() throw(Common::Error::ECapeUnknown) { return pExpData; };

        void SetFittingInterval(Common::Types::CapeDouble _startTime, Common::Types::CapeDouble _endTime) 
          throw (Common::Error::ECapeUnknown);

        virtual CapeLong GetFixedSoughtParamsCount() = 0;

        virtual CapeLong GetStateSoughtParamsCount() = 0;

        void SetStoringStateVariables(const CapeArrayString &names);
#ifndef SWIG    

        void SetStoringStateVariables(const CapeArrayLong &indices);
#endif

        inline const DianaNLPFullMatrixDouble& GetStoredStates() {
          return statesMatrix;
        }

        inline Numeric::Solvers::Eso::ICapeNumericESO* GetActiveESO() 
          throw(Common::Error::ECapeUnknown) { 
          return this->pOldESO; 
        }

        // methods for outputting parameterfitting results (TODO: make a report for tasks)
        void EnableOutput(const Common::Types::CapeString& stream_name)
          throw(Common::Error::ECapeUnknown);
        void DisableOutput();

        void SetOutputStateVariables(const CapeArrayString &names);

        void SetReportingInterface(ParameterFittingTaskReport* _pReportingInterface);

        void Output(Diana::SolverEvents event) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation);

        ICapeNumericESO* GetOldESO () { return pOldESO; }

      protected:
        inline Common::Types::CapeBoolean IsInFittingTimeInterval(Common::Types::CapeDouble dblVal) const { 
          return ((this->dblStartTime <= dblVal) && (this->dblEndTime >= dblVal)); 
        }

        void StorePointVariable(const Common::Types::CapeArrayDouble& _vars) {
          statesMatrix.push_back(_vars);
        }

      protected:
        /* Information for solver's creation */
        Diana::IDianaMain* dianaMain;                           
        Common::Types::CapeString strSolverLibrary;             

        const Common::NLPData::CapeMeasuredData* pExpData;      

        Common::Types::CapeBoolean isPrepearedStatesMatrix;     
        DianaNLPFullMatrixDouble statesMatrix;                  
        Common::Types::CapeArrayLong statesIndices;             

        Common::Types::CapeDouble dblStartTime;                 
        Common::Types::CapeDouble dblEndTime;                   

        Common::Types::CapeBoolean enabledOutput;               
        FILE *out_stream;                                       
        Common::Types::CapeArrayLong idxOutStates;              

        ICapeNumericESO* pOldESO;                               

        ParameterFittingTaskReport* report;                     

        Common::Types::CapeBoolean bInitialized;                

      };


      class ParameterFittingTask : public DianaParameterFittingTask, public IDianaSensitivityTaskCreator {
      public:

        ParameterFittingTask(ICapeNumericSolver* _solver, ICapeNumericContinuousModel* _model, const Common::NLPData::CapeMeasuredData* _expdata,
                             const Common::Parameter::CapeArrayParameterSpec& _fixedSoughtParams, 
                             const Common::Parameter::CapeArrayParameterSpec& _stateSoughtParams) throw(Common::Error::ECapeInvalidArgument, Common::Error::ECapeUnknown);

        ParameterFittingTask(ICapeNumericSolver* _solver, ICapeNumericContinuousModel* _model, const Common::NLPData::CapeMeasuredData* _expdata,
                             const Common::Parameter::CapeArrayParameterSpec& _fixedSoughtParams) throw(Common::Error::ECapeInvalidArgument, Common::Error::ECapeUnknown);


        ParameterFittingTask(IDianaMain* _dianaMain, CapeString _solverName, ICapeNumericContinuousModel* _model, const Common::NLPData::CapeMeasuredData* _expdata,
                             const Common::Parameter::CapeArrayParameterSpec& _fixedSoughtParams, 
                             const Common::Parameter::CapeArrayParameterSpec& _stateSoughtParams) throw(Common::Error::ECapeInvalidArgument, Common::Error::ECapeUnknown);

        ParameterFittingTask(IDianaMain* _dianaMain, CapeString _solverName, ICapeNumericContinuousModel* _model, const Common::NLPData::CapeMeasuredData* _expdata,
                             const Common::Parameter::CapeArrayParameterSpec& _fixedSoughtParams) throw(Common::Error::ECapeInvalidArgument, Common::Error::ECapeUnknown);

        virtual ~ParameterFittingTask();

        virtual eCapeNLPTaskType Type() const { return CAPE_NULLRANGE; }

        virtual CapeDouble CalcObjFunction() 
          throw(Common::Error::ECapeUnknown, Common::Error::ECapeSolvingError);

        virtual inline CapeLong GetFixedSoughtParamsCount() { return soughtParams.Count() - cntStateSoughtParams; };

        virtual inline CapeLong GetStateSoughtParamsCount() { return cntStateSoughtParams; };

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

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

        Numeric::Solvers::NLPTasks::ICapeNLPTask* GetSensitivityTask()
          throw(Common::Error::ECapeInvalidArgument, Common::Error::ECapeUnknown);

      private:
        void ExtractParams(const Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& _parVals)
          throw(Common::Error::ECapeUnknown);

        inline Common::Types::CapeBoolean IsInFittingTimeInterval(Common::Types::CapeDouble dblVal) const { return ((this->dblStartTime <= dblVal) && (dblEndTime >= dblVal)); };

        void InitTask(const Common::Parameter::CapeArrayParameterSpec* _fixedSoughtParams, 
                      const Common::Parameter::CapeArrayParameterSpec* _stateSoughtParams) throw(Common::Error::ECapeInvalidArgument, Common::Error::ECapeUnknown);

        virtual void InitTask(IDianaMain* _dianaMain, CapeString _solverName, ICapeNumericContinuousModel* _model, 
                              const  Common::Parameter::CapeArrayParameterSpec* _fixedSoughtParams, 
                              const  Common::Parameter::CapeArrayParameterSpec* _stateSoughtParams)
          throw(Common::Error::ECapeUnknown){}
        virtual void InitTask(IDianaMain* _dianaMain, CapeString _solverName, ICapeNumericContinuousModel* _model, 
                              const CapeArrayString* _fixedSoughtParams, const CapeArrayString* _stateSoughtParams)
          throw(Common::Error::ECapeUnknown){}
        virtual void InitTask(IDianaMain* _dianaMain, CapeString _solverName, ICapeNumericContinuousModel* _model, 
                              const CapeArrayLong* _fixedSoughtParams, const CapeArrayLong* _stateSoughtParams)
          throw(Common::Error::ECapeUnknown){}

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

      private:

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

        CapeLong cntStateSoughtParams;              
      };


      class SensParameterFittingTask : public DianaParameterFittingTask, public ICapeSensNLPTask {
      public:
#ifndef SWIG

        SensParameterFittingTask(Numeric::Solvers::Solver::ICapeNumericSolver* _solver, 
                                 Diana::IDianaContinuousModel* _model, 
                                 Common::NLPData::CapeMeasuredData* _expdata);
#endif

        SensParameterFittingTask(Diana::IDianaMain* _dianaMain, Common::Types::CapeString _solverName, 
                                 Numeric::Solvers::Model::ICapeNumericContinuousModel* _model, 
                                 const Common::NLPData::CapeMeasuredData* _expdata);

        SensParameterFittingTask(Diana::IDianaMain* _dianaMain, Common::Types::CapeString _solverName, 
                                 Numeric::Solvers::Model::ICapeNumericContinuousModel* _model, 
                                 const Common::NLPData::CapeMeasuredData* _expdata, const Common::Collection::ICapeCollection *pars);

        virtual ~SensParameterFittingTask();

        virtual void AddEstimatedParameterBySpec(const Common::Parameter::ICapeParameterSpec* pSpecValue, 
                                                 eEstimatedParameterType eptTypeOfUnknown = DIANA_PARAMETER)
          throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

        virtual void AddEstimatedParameterByName(const Common::Types::CapeString strName, 
                                                 eEstimatedParameterType eptTypeOfUnknown = DIANA_PARAMETER)
          throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

        virtual void AddEstimatedParameterByIndex(const Common::Types::CapeLong nIndex, 
                                                  eEstimatedParameterType eptTypeOfUnknown = DIANA_PARAMETER)
          throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument);

        inline Common::Types::CapeLong GetFixedSoughtParamsCount() { 
          return arrEstimatedParameters.size(); // dynamic_cast<Diana::DianaSensDAESO*>(pESO)->GetNumSensParameters(); 
        }

        inline Common::Types::CapeLong GetStateSoughtParamsCount() { 
          return arrEstimatedInitStates.size(); // dynamic_cast<Diana::DianaSensDAESO*>(pESO)->GetNumSensInitStates(); 
        }

        virtual eCapeNLPTaskType Type()  const { return CAPE_FIRSTRANGE; }

        virtual Common::Types::CapeDouble CalcObjFunction() 
          throw(Common::Error::ECapeUnknown, Common::Error::ECapeSolvingError);

        virtual Common::Types::CapeArrayDouble GetObjFunctionGradient() 
          throw(Common::Error::ECapeUnknown, Common::Error::ECapeSolvingError);

        void ExecuteAllCalculations() 
          throw(Common::Error::ECapeUnknown, Common::Error::ECapeSolvingError);

        virtual const Diana::DianaSparseArray& GetConstraintsJacobian(ConstraintType _type)
          throw(Common::Error::ECapeUnknown, Common::Error::ECapeSolvingError);

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

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

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

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

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

      private:
        void ExtractParams(const  Numeric::Solvers::NLPTasks::Parameters::ICapeOptimizationPoint& _parVals)
          throw(Common::Error::ECapeUnknown);

      protected:

        /* Lists of unknowns */
        Common::Parameter::CapeArrayParameter arrEstimatedInitStates;   
        Common::Parameter::CapeArrayParameter arrEstimatedParameters;   

        /* Information for constraint's Jacobian calculation */
        Diana::DianaSparseArray mtrConstraintsJacobian; 
        Common::Types::CapeDouble dblEpsilon;           




        Common::Types::CapeBoolean bInitialized;        
      private:
        /* Elements for realization of interface ICapeIdentification */
        Common::Types::CapeString strName;              
        Common::Types::CapeString strDescription;       

        /* Buffers for default values of ESO's elements */
        Common::Types::CapeArrayDouble arrDefaultDerivatives;      
        Common::Types::CapeArrayDouble arrDefaultSensitivities;    
        Common::Types::CapeArrayDouble arrDefaultModelDerivatives; 
        Common::Types::CapeArrayDouble arrDefaultModelVariables;   
      };

      class ParameterFittingTaskReport : public Common::Utilities::ICapeUtilities
      {
      public:
        ParameterFittingTaskReport(const CapeString& _filename) throw(Common::Error::ECapeUnknown);

        ~ParameterFittingTaskReport() throw(Common::Error::ECapeUnknown);

        inline void Activate() { active = true; };
        inline void Deactivate() { active = false; };

        void Output(Diana::SolverEvents event, DianaParameterFittingTask *task) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeFailedInitialisation);

        void SetOutputParameters(const Common::Types::CapeArrayString &_strs) { outpars = _strs; };

        Common::Collection::ICapeCollection* GetParameters()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation,
                 Common::Error::ECapeNoImpl);

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

        void Initialize()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation,
                 Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError,
                 Common::Error::ECapeBadInvOrder);
  
        void Terminate()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeOutOfResources,
                 Common::Error::ECapeBadInvOrder);

      private:
        CapeBoolean active;                      

        FILE * plot_pipe;                        
        CapeBoolean Initialized;                 
        CapeString fname;                        
        CapeArrayString outpars;                 

        Diana::DianaCollection collParameters; 

      };
    }
  }
}

#endif // DIANA_PARAMETERFITTINGTASK_HPP