IdentityFunction.h

Go to the documentation of this file.

#ifndef _OCRABASE_IDENTITY_FUNCTION_H_
#define _OCRABASE_IDENTITY_FUNCTION_H_

#ifdef WIN32
# pragma once
#endif

#include "ocra/optim/DiagonalLinearFunction.h"

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

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

  public:
    IdentityFunction(Variable& x, bool resizable = true);

    // ------------------------ public interface --------------------------------

    bool isResizable() const;

    // ------------------------ protected methods -------------------------------
  protected:
    virtual void updateValue() const;

    virtual void doUpdateInputSizeBegin();

    virtual void doUpdateInputSizeEnd();

    virtual void doChangeDiagonal(const VectorXd& d);
    virtual void doChangeDiagonal(const double diagonalElementValue, const bool changeDefault = true);
    virtual void doChangeDefaultDiagonalValue(const double v);
    virtual void doChangeDefaultbValue(const double v);

    virtual void doChangeA(const MatrixXd& A);

    // ------------------------ private methods -------------------------------
  private:
    void buildIdentity();

    // ------------------------ private members -------------------------------
  private:
    bool _resizable;
  };
}



#endif //_OCRABASE_IDENTITY_FUNCTION_H_

// cmake:sourcegroup=Function