CapeNLPTask.hpp

/*  -------------------------------------------------------------------------
 *                         CapeNLPUtils.hpp  -  description
 *                         -------------------
 *   begin                      : Mon Jan 2 2006
 *   author                     : Teplinskiy Konstantin
 *   email                      : konstantin.teplinskiy@gmail.com
 *   updated by Gogolenko Sergey: Tue Feb 14 2006
 *  -------------------------------------------------------------------------
 */

#ifndef OPTUTILS_H
#define OPTUTILS_H

#include <Basic/CapeBasic.hpp>
#include <Basic/CapeSolver.hpp>
#include <Basic/CapeModel.hpp>

#include <iomanip>

using namespace Common::Types;
using namespace Common::Error;

namespace Numeric {
  namespace Solvers {

    namespace NLPTasks {

      // Forward declaration of interfaces
      class ICapeNLPFunction;
      class ICapeNLPTask;

      class ICapeNumericNLPTaskFactory {
      public:
        virtual ICapeNLPTask* CreateNLPTask(Common::Types::CapeString strLibraryName)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeOutOfBounds, Common::Error::ECapeOutOfResources,
                 Common::Error::ECapeFailedInitialisation, Common::Error::ECapeUser) = 0;

        virtual Numeric::Solvers::NLPTasks::ICapeNLPTask* CreateOEDTask(Numeric::Solvers::NLPTasks::ICapeNLPTask* pParFitTask,
                                                                        Numeric::Solvers::Solver::ICapeNumericNLPSolver* pOptimizer,
                                                                        const Common::Parameter::CapeArrayParameterSpec& colDesignVars,
                                                                        Common::Types::CapeString strLibraryName)
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument,
                 Common::Error::ECapeOutOfBounds, Common::Error::ECapeOutOfResources,
                 Common::Error::ECapeFailedInitialisation, Common::Error::ECapeUser) = 0;

        virtual void Shutdown()
          throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) = 0;
      };

      typedef std::vector<ICapeNLPFunction*> ConstraintFuncArray;
      typedef std::vector<ICapeNLPTask*> CapeArrayNLPTask;

      typedef enum {
        ctGx,   
        ctHx    
      } ConstraintType;

      class ICapeNLPFunction : public Common::Identification::ICapeIdentification {
      public:
        virtual Common::Types::CapeDouble Exec(ICapeNLPTask&task) throw (Common::Error::ECapeSolvingError) = 0;

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


      class ICapeNLPTask : public Common::Utilities::ICapeUtilities, public Common::Identification::ICapeIdentification {
      public:

        virtual ~ICapeNLPTask() {}

        virtual eCapeNLPTaskType Type() const = 0;

        virtual const Common::Collection::ICapeCollection& GetSoughtParameters() const
          throw(Common::Error::ECapeUnknown) = 0;

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

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

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

        virtual const Parameters::ICapeOptimizationPoint& GetNLPParameters() throw(Common::Error::ECapeUnknown) = 0;

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

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

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

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

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

      class ICapeSensNLPTask : virtual public ICapeNLPTask {
      public:
        virtual ~ICapeSensNLPTask() {}

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

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

      };

//       namespace Model {
//      class ICapeNumericContinuousModel;
//       }

//       namespace Solver {
//      class ICapeNumericSolver;
//       }

      class ICapeDynamicOptimizationTask : virtual public ICapeNLPTask {
      public:
        virtual ~ICapeDynamicOptimizationTask() {}

        virtual Numeric::Solvers::Model::ICapeNumericContinuousModel* GetModel() 
          throw(Common::Error::ECapeUnknown) = 0;

        virtual Numeric::Solvers::Solver::ICapeNumericSolver* GetIntegrator() 
          throw(Common::Error::ECapeUnknown) = 0;
      };

    }
  }
}

#endif //OPTUTILS_H