BoundFunction.h

Go to the documentation of this file.

#ifndef _OCRABASE_BOUND_FUNCTION_H_
#define _OCRABASE_BOUND_FUNCTION_H_

#ifdef WIN32
# pragma once
#endif

// includes
#include "ocra/optim/DiagonalLinearFunction.h"

namespace ocra
{
  enum eBoundType
  {
    BOUND_TYPE_INFERIOR = -1,
    BOUND_TYPE_SUPERIOR = 1
  };


  class BoundFunction : public DiagonalLinearFunction
  {

    // ------------------------ structures --------------------------------------
  public:
    typedef DiagonalLinearFunction  functionType_t;     //< alias on the type of the mother class. Needed to duplicate the function tree.

    // ------------------------ constructors ------------------------------------
  private:
    BoundFunction(const BoundFunction&);
    BoundFunction& operator= (const BoundFunction&);

  public:
    BoundFunction(Variable& x, const VectorXd& bound, eBoundType type);
    BoundFunction(Variable& x, const double bound, eBoundType type);

    // ------------------------ public interface --------------------------------
  public:
    void changeBounds(const double bound);
    void changeBounds(const VectorXd& bounds);

    void changeIthBound(const int i, const double bound);


    // ------------------------ protected methods -------------------------------
  protected:
    void doChangeDiagonal(const VectorXd& d);
    void doChangeDiagonal(const double diagonalElementValue, const bool changeDefault = true);
    void doChangeDefaultDiagonalValue(const double v);
    void doChangeDefaultbValue(const double v);
  };
}

#endif  //_OCRABASE_BOUND_FUNCTION_H_

// cmake:sourcegroup=Function