CapeNLPParameter.hpp

#ifndef CAPE_NLP_PARAMETER_H
#define CAPE_NLP_PARAMETER_H

#include "CapeParameter.hpp"

namespace Common {
  namespace Parameter {
    
    class ICapeNLPRealParameterSpec : virtual public ICapeRealParameterSpec {
    public:
      virtual Common::Types::CapeDouble Precision() const
        throw (Common::Error::ECapeUnknown) = 0;
    };
  }
}
namespace Numeric {
  namespace Solvers {
    namespace NLPTasks {

      enum eCapeNLPTaskType  {
        CAPE_NULLRANGE  = 0x00,
        CAPE_FIRSTRANGE = 0x01,
        CAPE_SQP        = 0x02 
      };

      enum eCapeOptPointEntry {
        CAPE_OBJFUNC    = 0x01, 
        CAPE_GXCONSTR   = 0x02, 
        CAPE_HXCONSTR   = 0x04, 
        CAPE_GRADIENT   = 0x08, 
        CAPE_LSJAC      = 0x0F  
      };


      namespace Parameters {
        
        class ICapeOptimizationPoint : virtual public Common::Identification::ICapeIdentification {
        public:
          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
            throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) = 0;

          virtual Common::Types::CapeLong ValStatus() const
            throw(Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) = 0;

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

          virtual Common::Parameter::ICapeParameterSpec* GetParameterSpec(Common::Types::CapeLong _idx) const
            throw(Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) = 0;

          virtual Common::Types::CapeLong GetParametersCount() const = 0;

          virtual Common::Types::CapeDouble GetObjFunction() const = 0;

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

          virtual Common::Types::CapeValidationStatus Update()
            throw(Common::Error::ECapeUnknown) = 0;

#ifndef SWIG

          friend std::ostream& operator<<(std::ostream& out_file, const ICapeOptimizationPoint&);
#endif
        };


#ifndef SWIG

   std::ostream& operator<<(std::ostream& out_file, const ICapeOptimizationPoint&);
#endif

        class ICapeSensOptimizationPoint : virtual public ICapeOptimizationPoint {
        public:
          virtual ~ICapeSensOptimizationPoint(){}

          virtual const Common::Types::CapeArrayDouble& GetGradient() const = 0;
        };

      }
    }
  }
}

#endif //CAPE_NLP_PARAMETER_H