IFunctionProperties.h

Go to the documentation of this file.

#ifndef _OCRABASE_IFUNCTION_PROPERTIES_H_
#define _OCRABASE_IFUNCTION_PROPERTIES_H_

#ifdef WIN32
# pragma once
#endif

#include <string>
#include <vector>

namespace ocra
{
  enum eFunctionContinuity
  {
    CONTINUITY_C0 = 0,
    CONTINUITY_C1,
    CONTINUITY_C2,
    CONTINUITY_C3,
    CONTINUITY_C4,
    CONTINUITY_CINF = 0xfff-1,
    CONTINUITY_UNKNOWN
  };

  enum eFunctionLinearity
  {
    LINEARITY_CONSTANT,               //< \f$ f(x)=a \f$, \f$ a \in R^m \f$
    LINEARITY_LINEAR,                 //< \f$ f(x)=Ax+b \f$, \f$ A \in R^{m \times n} \f$, \f$ b \in R^m \f$
    LINEARITY_QUADRATIC,              //< \f$ f_i(x)=x^T P_i x + q_i^T x + r_i \f$, \f$ P_i \in S^n \f$, \f$ q_i \in R^n \f$, \f$ r_i \in R \f$
    LINEARITY_LINEAR_FRACTIONAL,      //< \f$ f_i(x)=\frac{a_i^T x + b_i}{c_i^T x + d_i} \f$, \f$ a_i, c_i \in R^n \f$, \f$ b_i, d_i \in R \f$, \f$ c_i^T x + d_i>0 \f$
    LINEARITY_UNDEFINED
  };

  enum eFunctionConvexity
  {
    CONVEXITY_CONVEX,                 //< \f$ D_f \f$ is convex and \f$ f(tx+(1-u)y \leq tf(x)+(1-u)f(y) \f$, with \f$ u \in \left[0,1\right] \f$
    CONVEXITY_STRICTLY_CONVEX,        //< \f$ D_f \f$ is convex and \f$ f(tx+(1-u)y < tf(x)+(1-u)f(y) \f$, with \f$ u \in \left[0,1\right] \f$
    CONVEXITY_CONCAVE,                //< \f$ -f \f$ is convex
    CONVEXITY_STRICTLY_CONCAVE,       //< \f$ -f \f$ is stricly convex
    CONVEXITY_CONVEX_AND_CONCAVE,     //< \f$ f \f$ is linear
    CONVEXITY_LOG_CONVEX,             //< \f$ f>0 \f$ and \f$ \log f \f$ is convex
    CONVEXITY_LOG_CONCAVE,            //< \f$ f>0 \f$ and \f$ \log f \f$ is concave
    CONVEXITY_QUASICONVEX,            //< \f$ D_f \f$ is convex and all \f$ S_{\alpha} = {x \in D_f | f(x) \leq \alpha} \f$ are convex
    CONVEXITY_QUASICONCAVE,           //< \f$ -f \f$ is quasiconvex
    CONVEXITY_QUASILINEAR,            //< \f$ f \f$ is quasiconvex and quasiconcave
    CONVEXITY_UNDEFINED
  };


  class IFunctionProperties
  {
  protected:
    IFunctionProperties(eFunctionLinearity linearity = LINEARITY_UNDEFINED, 
              eFunctionConvexity convexity = CONVEXITY_UNDEFINED, int continuity = CONTINUITY_UNKNOWN,
              bool explicitlyTimeDependant=false, bool separableTimeDependancy = true);

  private:
    IFunctionProperties(const IFunctionProperties&);
    IFunctionProperties& operator= (const IFunctionProperties&);

  public:

    eFunctionLinearity  getType(void) const;
    eFunctionConvexity  getConvexityProperty(void) const;
    int                 getContinuityProperty(void) const;
    const std::string&  getProperty(int i) const;
    int                 getNumberOfProperties(void) const;
    bool                hasProperty(const std::string& functionProperty) const;
    bool                isExplicitlyTimeDependant(void) const;

    bool                hasSeparableTimeDependancy(void) const;



  protected:
    void  changeType(eFunctionLinearity newType);

    void  changeConvexityProperty(eFunctionConvexity newProperty);

    void  changeContinuityProperty(int newProperty);

    void  addProperty(const std::string& functionProperty);

    void  removeProperty(const std::string& functionProperty);

    void changeExplicitTimeDependancy(bool b);

    void changeSeparableTimeDependancy(bool b);
    


  private:
    eFunctionLinearity        _type;                    //< linearity
    eFunctionConvexity        _convexityProperty;       //< convexity
    int                       _continuityProperty;      //< continuity
    std::vector<std::string>  _properties;              //< for additional properties aside from continuity, convexity and linearity
    bool                      _timeDependant;           //< explicit time dependancy
    bool                      _separableTimeDependancy; //< true if f can be written g(x)+h(t)
  };
}

#endif //_OCRABASE_IFUNCTION_PROPERTIES_H_

// cmake:sourcegroup=Function