RhodeCode

    ///Add a new empty column (i.e a new variable) to the LP

    Col addCol() { Col c; c._id = _addColId(_addCol()); return c;}

    ///\brief Adds several new columns (i.e variables) at once

    ///

    ///This magic function takes a container as its argument and fills

    ///its elements with new columns (i.e. variables)

    ///\param t can be

    ///- a standard STL compatible iterable container with

    ///\ref Col as its \c values_type like

    ///\code

    ///std::vector<LpBase::Col>

    ///std::list<LpBase::Col>

    ///\endcode

    ///- a standard STL compatible iterable container with

    ///\ref Col as its \c mapped_type like

    ///\code

    ///std::map<AnyType,LpBase::Col>

    ///\endcode

    ///- an iterable lemon \ref concepts::WriteMap "write map" like

    ///\code

    ///ListGraph::NodeMap<LpBase::Col>

    ///ListGraph::ArcMap<LpBase::Col>

    ///\endcode

    ///\return The number of the created column.

#ifdef DOXYGEN

    template<class T>

    int addColSet(T &t) { return 0;}

#else

    template<class T>

    typename enable_if<typename T::value_type::LpCol,int>::type

    addColSet(T &t,dummy<0> = 0) {

      int s=0;

      for(typename T::iterator i=t.begin();i!=t.end();++i) {*i=addCol();s++;}

      return s;

    }

    template<class T>

    typename enable_if<typename T::value_type::second_type::LpCol,

                       int>::type

    addColSet(T &t,dummy<1> = 1) {

      int s=0;

      for(typename T::iterator i=t.begin();i!=t.end();++i) {

        i->second=addCol();

        s++;

      }

      return s;

    }

    template<class T>

    typename enable_if<typename T::MapIt::Value::LpCol,

                       int>::type

    addColSet(T &t,dummy<2> = 2) {

      int s=0;

      for(typename T::MapIt i(t); i!=INVALID; ++i)

        {

          i.set(addCol());

          s++;

        }

      return s;

    }

#endif

    ///Set a column (i.e a dual constraint) of the LP

    ///\param c is the column to be modified

    ///\param e is a dual linear expression (see \ref DualExpr)

    ///a better one.

    void col(Col c, const DualExpr &e) {

      e.simplify();

      _setColCoeffs(cols(id(c)), ExprIterator(e.comps.begin(), rows),

                    ExprIterator(e.comps.end(), rows));

    }

    ///Get a column (i.e a dual constraint) of the LP

    ///\param c is the column to get

    ///\return the dual expression associated to the column

    DualExpr col(Col c) const {

      DualExpr e;

      _getColCoeffs(cols(id(c)), InsertIterator(e.comps, rows));

      return e;

    }

    ///Add a new column to the LP

    ///\param e is a dual linear expression (see \ref DualExpr)

    ///\param o is the corresponding component of the objective

    ///function. It is 0 by default.

    ///\return The created column.

    Col addCol(const DualExpr &e, Value o = 0) {

      Col c=addCol();

      col(c,e);

      objCoeff(c,o);

      return c;

    }

    ///Add a new empty row (i.e a new constraint) to the LP

    ///This function adds a new empty row (i.e a new constraint) to the LP.

    ///\return The created row

    Row addRow() { Row r; r._id = _addRowId(_addRow()); return r;}

    ///\brief Add several new rows (i.e constraints) at once

    ///

    ///This magic function takes a container as its argument and fills

    ///its elements with new row (i.e. variables)

    ///\param t can be

    ///- a standard STL compatible iterable container with

    ///\ref Row as its \c values_type like

    ///\code

    ///std::vector<LpBase::Row>

    ///std::list<LpBase::Row>

    ///\endcode

    ///- a standard STL compatible iterable container with

    ///\ref Row as its \c mapped_type like

    ///\code

    ///std::map<AnyType,LpBase::Row>

    ///\endcode

    ///- an iterable lemon \ref concepts::WriteMap "write map" like

    ///\code

    ///ListGraph::NodeMap<LpBase::Row>

    ///ListGraph::ArcMap<LpBase::Row>

    ///\endcode

    ///\return The number of rows created.

#ifdef DOXYGEN

    template<class T>

    int addRowSet(T &t) { return 0;}

#else

    template<class T>

    typename enable_if<typename T::value_type::LpRow,int>::type

    addRowSet(T &t, dummy<0> = 0) {

      int s=0;

      for(typename T::iterator i=t.begin();i!=t.end();++i) {*i=addRow();s++;}

      return s;

    }

    template<class T>

    typename enable_if<typename T::value_type::second_type::LpRow, int>::type

    addRowSet(T &t, dummy<1> = 1) {

      int s=0;

      for(typename T::iterator i=t.begin();i!=t.end();++i) {

        i->second=addRow();

        s++;

      }

      return s;

    }

    template<class T>

    typename enable_if<typename T::MapIt::Value::LpRow, int>::type

    addRowSet(T &t, dummy<2> = 2) {

      int s=0;

      for(typename T::MapIt i(t); i!=INVALID; ++i)

        {

          i.set(addRow());

          s++;

        }

      return s;

    }

#endif

    ///Set a row (i.e a constraint) of the LP

    ///\param r is the row to be modified

    ///\param l is lower bound (-\ref INF means no bound)

    ///\param e is a linear expression (see \ref Expr)

    ///\param u is the upper bound (\ref INF means no bound)

    void row(Row r, Value l, const Expr &e, Value u) {

      e.simplify();

      _setRowCoeffs(rows(id(r)), ExprIterator(e.comps.begin(), cols),

                    ExprIterator(e.comps.end(), cols));

      _setRowLowerBound(rows(id(r)),l - *e);

      _setRowUpperBound(rows(id(r)),u - *e);

    }

    ///Set a row (i.e a constraint) of the LP

    ///\param r is the row to be modified

    ///\param c is a linear expression (see \ref Constr)

    void row(Row r, const Constr &c) {

      row(r, c.lowerBounded()?c.lowerBound():-INF,

          c.expr(), c.upperBounded()?c.upperBound():INF);

    }

    ///Get a row (i.e a constraint) of the LP

    ///\param r is the row to get

    ///\return the expression associated to the row

    Expr row(Row r) const {

      Expr e;

      _getRowCoeffs(rows(id(r)), InsertIterator(e.comps, cols));

      return e;

    }

    ///Add a new row (i.e a new constraint) to the LP

    ///\param l is the lower bound (-\ref INF means no bound)

    ///\param e is a linear expression (see \ref Expr)

    ///\param u is the upper bound (\ref INF means no bound)

    ///\return The created row.

    Row addRow(Value l,const Expr &e, Value u) {

      Row r=addRow();

      row(r,l,e,u);

      return r;

    }

    ///Add a new row (i.e a new constraint) to the LP

    ///\param c is a linear expression (see \ref Constr)

    ///\return The created row.

    Row addRow(const Constr &c) {

      Row r=addRow();

      row(r,c);

      return r;

    }

    ///Erase a column (i.e a variable) from the LP

    ///\param c is the column to be deleted

    void erase(Col c) {

      _eraseCol(cols(id(c)));

      _eraseColId(cols(id(c)));

    }

    ///Erase a row (i.e a constraint) from the LP

    ///\param r is the row to be deleted

    void erase(Row r) {

      _eraseRow(rows(id(r)));

      _eraseRowId(rows(id(r)));

    }

    /// Get the name of a column

    ///\param c is the coresponding column

    ///\return The name of the colunm

    std::string colName(Col c) const {

      std::string name;

      _getColName(cols(id(c)), name);

      return name;

    }

    /// Set the name of a column

    ///\param c is the coresponding column

    ///\param name The name to be given

    void colName(Col c, const std::string& name) {

      _setColName(cols(id(c)), name);

    }

    /// Get the column by its name

    ///\param name The name of the column

    ///\return the proper column or \c INVALID

    Col colByName(const std::string& name) const {

      int k = _colByName(name);

      return k != -1 ? Col(cols[k]) : Col(INVALID);

    }

    /// Get the name of a row

    ///\param r is the coresponding row

    ///\return The name of the row

    std::string rowName(Row r) const {

      std::string name;

      _getRowName(rows(id(r)), name);

      return name;

    }

    /// Set the name of a row

    ///\param r is the coresponding row

    ///\param name The name to be given

    void rowName(Row r, const std::string& name) {

      _setRowName(rows(id(r)), name);

    }

    /// Get the row by its name

    ///\param name The name of the row

    ///\return the proper row or \c INVALID

    Row rowByName(const std::string& name) const {

      int k = _rowByName(name);

      return k != -1 ? Row(rows[k]) : Row(INVALID);

    }

    /// Set an element of the coefficient matrix of the LP

    ///\param r is the row of the element to be modified

    ///\param c is the column of the element to be modified

    ///\param val is the new value of the coefficient

    void coeff(Row r, Col c, Value val) {

      _setCoeff(rows(id(r)),cols(id(c)), val);

    }

    /// Get an element of the coefficient matrix of the LP

    ///\param r is the row of the element

    ///\param c is the column of the element

    ///\return the corresponding coefficient

    Value coeff(Row r, Col c) const {

      return _getCoeff(rows(id(r)),cols(id(c)));

    }

    /// Set the lower bound of a column (i.e a variable)

    /// The lower bound of a variable (column) has to be given by an

    /// extended number of type Value, i.e. a finite number of type

    /// Value or -\ref INF.

    void colLowerBound(Col c, Value value) {

      _setColLowerBound(cols(id(c)),value);

    }

    /// Get the lower bound of a column (i.e a variable)

    /// This function returns the lower bound for column (variable) \c c

    /// (this might be -\ref INF as well).

    ///\return The lower bound for column \c c

    Value colLowerBound(Col c) const {

      return _getColLowerBound(cols(id(c)));

    }

    ///\brief Set the lower bound of  several columns

    ///(i.e variables) at once

    ///

    ///This magic function takes a container as its argument

    ///and applies the function on all of its elements.

    ///The lower bound of a variable (column) has to be given by an

    ///extended number of type Value, i.e. a finite number of type

    ///Value or -\ref INF.

#ifdef DOXYGEN

    template<class T>

    void colLowerBound(T &t, Value value) { return 0;}

#else

    template<class T>

    typename enable_if<typename T::value_type::LpCol,void>::type

    colLowerBound(T &t, Value value,dummy<0> = 0) {

      for(typename T::iterator i=t.begin();i!=t.end();++i) {

        colLowerBound(*i, value);

      }

    }

    template<class T>

    typename enable_if<typename T::value_type::second_type::LpCol,

                       void>::type

    colLowerBound(T &t, Value value,dummy<1> = 1) {

      for(typename T::iterator i=t.begin();i!=t.end();++i) {

        colLowerBound(i->second, value);

      }

    }

    template<class T>

    typename enable_if<typename T::MapIt::Value::LpCol,

                       void>::type

    colLowerBound(T &t, Value value,dummy<2> = 2) {

      for(typename T::MapIt i(t); i!=INVALID; ++i){

        colLowerBound(*i, value);

      }

    }

#endif

    /// Set the upper bound of a column (i.e a variable)

    /// The upper bound of a variable (column) has to be given by an

    /// extended number of type Value, i.e. a finite number of type

    /// Value or \ref INF.

    void colUpperBound(Col c, Value value) {

      _setColUpperBound(cols(id(c)),value);

    };

    /// Get the upper bound of a column (i.e a variable)

    /// This function returns the upper bound for column (variable) \c c

    /// (this might be \ref INF as well).

    /// \return The upper bound for column \c c

    Value colUpperBound(Col c) const {

      return _getColUpperBound(cols(id(c)));

    }

    ///\brief Set the upper bound of  several columns

    ///(i.e variables) at once

    ///

    ///This magic function takes a container as its argument

    ///and applies the function on all of its elements.

    ///The upper bound of a variable (column) has to be given by an

    ///extended number of type Value, i.e. a finite number of type

    ///Value or \ref INF.

#ifdef DOXYGEN

    template<class T>

    void colUpperBound(T &t, Value value) { return 0;}

#else

        colUpperBound(*i, value);

      }

    }

                       void>::type

        colUpperBound(i->second, value);

      }

    }

                       void>::type

        colUpperBound(*i, value);

      }

    }

#endif

    /// Set the lower and the upper bounds of a column (i.e a variable)

    /// The lower and the upper bounds of

    /// a variable (column) have to be given by an

    /// extended number of type Value, i.e. a finite number of type

    /// Value, -\ref INF or \ref INF.

    void colBounds(Col c, Value lower, Value upper) {

      _setColLowerBound(cols(id(c)),lower);

      _setColUpperBound(cols(id(c)),upper);

    }

    ///\brief Set the lower and the upper bound of several columns

    ///(i.e variables) at once

    ///

    ///This magic function takes a container as its argument

    ///and applies the function on all of its elements.

    /// The lower and the upper bounds of

    /// a variable (column) have to be given by an

    /// extended number of type Value, i.e. a finite number of type

    /// Value, -\ref INF or \ref INF.

#ifdef DOXYGEN

    template<class T>

    void colBounds(T &t, Value lower, Value upper) { return 0;}

#else

        colBounds(*i, lower, upper);

      }

    }

        colBounds(i->second, lower, upper);

      }

    }

        colBounds(*i, lower, upper);

      }

    }

#endif

    /// Set the lower bound of a row (i.e a constraint)

    /// The lower bound of a constraint (row) has to be given by an

    /// extended number of type Value, i.e. a finite number of type

    /// Value or -\ref INF.

    void rowLowerBound(Row r, Value value) {

      _setRowLowerBound(rows(id(r)),value);

    }

    /// Get the lower bound of a row (i.e a constraint)

    /// This function returns the lower bound for row (constraint) \c c

    /// (this might be -\ref INF as well).

    ///\return The lower bound for row \c r

    Value rowLowerBound(Row r) const {

      return _getRowLowerBound(rows(id(r)));

    }

    /// Set the upper bound of a row (i.e a constraint)

    /// The upper bound of a constraint (row) has to be given by an

    /// extended number of type Value, i.e. a finite number of type

    /// Value or -\ref INF.

    void rowUpperBound(Row r, Value value) {

      _setRowUpperBound(rows(id(r)),value);

    }

    /// Get the upper bound of a row (i.e a constraint)

    /// This function returns the upper bound for row (constraint) \c c

    /// (this might be -\ref INF as well).

    ///\return The upper bound for row \c r

    Value rowUpperBound(Row r) const {

      return _getRowUpperBound(rows(id(r)));

    }

    ///Set an element of the objective function

    void objCoeff(Col c, Value v) {_setObjCoeff(cols(id(c)),v); };

    ///Get an element of the objective function

    Value objCoeff(Col c) const { return _getObjCoeff(cols(id(c))); };

    ///Set the objective function

    ///\param e is a linear expression of type \ref Expr.

    ///

    void obj(const Expr& e) {

      _setObjCoeffs(ExprIterator(e.comps.begin(), cols),

                    ExprIterator(e.comps.end(), cols));

      obj_const_comp = *e;

    }

    ///Get the objective function

    ///\return the objective function as a linear expression of type

    ///Expr.

    Expr obj() const {

      Expr e;

      _getObjCoeffs(InsertIterator(e.comps, cols));

      *e = obj_const_comp;

      return e;

    }

    ///Set the direction of optimization

    void sense(Sense sense) { _setSense(sense); }

    ///Query the direction of the optimization

    Sense sense() const {return _getSense(); }

    ///Set the sense to maximization

    void max() { _setSense(MAX); }

    ///Set the sense to maximization

    void min() { _setSense(MIN); }

    ///Clears the problem

    void clear() { _clear(); }

    ///@}

  };

  /// Addition

  ///\relates LpBase::Expr

  ///

  inline LpBase::Expr operator+(const LpBase::Expr &a, const LpBase::Expr &b) {

    LpBase::Expr tmp(a);

    tmp+=b;

    return tmp;

  }

  ///Substraction

  ///\relates LpBase::Expr

  ///

  inline LpBase::Expr operator-(const LpBase::Expr &a, const LpBase::Expr &b) {

    LpBase::Expr tmp(a);

    tmp-=b;

    return tmp;

  }

  ///Multiply with constant

  ///\relates LpBase::Expr

  ///

  inline LpBase::Expr operator*(const LpBase::Expr &a, const LpBase::Value &b) {

    LpBase::Expr tmp(a);

    tmp*=b;

    return tmp;

  }

  ///Multiply with constant

  ///\relates LpBase::Expr

  ///

  inline LpBase::Expr operator*(const LpBase::Value &a, const LpBase::Expr &b) {

    LpBase::Expr tmp(b);

    tmp*=a;

    return tmp;

  }

  ///Divide with constant

  ///\relates LpBase::Expr

  ///

  inline LpBase::Expr operator/(const LpBase::Expr &a, const LpBase::Value &b) {

    LpBase::Expr tmp(a);

    tmp/=b;

    return tmp;

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator<=(const LpBase::Expr &e,

                                   const LpBase::Expr &f) {

    return LpBase::Constr(0, f - e, LpBase::INF);

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator<=(const LpBase::Value &e,

                                   const LpBase::Expr &f) {

    return LpBase::Constr(e, f, LpBase::NaN);

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator<=(const LpBase::Expr &e,

                                   const LpBase::Value &f) {

    return LpBase::Constr(- LpBase::INF, e, f);

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator>=(const LpBase::Expr &e,

                                   const LpBase::Expr &f) {

    return LpBase::Constr(0, e - f, LpBase::INF);

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator>=(const LpBase::Value &e,

                                   const LpBase::Expr &f) {

    return LpBase::Constr(LpBase::NaN, f, e);

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator>=(const LpBase::Expr &e,

                                   const LpBase::Value &f) {

    return LpBase::Constr(f, e, LpBase::INF);

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator==(const LpBase::Expr &e,

                                   const LpBase::Value &f) {

    return LpBase::Constr(f, e, f);

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator==(const LpBase::Expr &e,

                                   const LpBase::Expr &f) {

    return LpBase::Constr(0, f - e, 0);

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator<=(const LpBase::Value &n,

                                   const LpBase::Constr &c) {

    LpBase::Constr tmp(c);

    LEMON_ASSERT(isNaN(tmp.lowerBound()), "Wrong LP constraint");

    tmp.lowerBound()=n;

    return tmp;

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator<=(const LpBase::Constr &c,

                                   const LpBase::Value &n)

  {

    LpBase::Constr tmp(c);

    LEMON_ASSERT(isNaN(tmp.upperBound()), "Wrong LP constraint");

    tmp.upperBound()=n;

    return tmp;

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator>=(const LpBase::Value &n,

                                   const LpBase::Constr &c) {

    LpBase::Constr tmp(c);

    LEMON_ASSERT(isNaN(tmp.upperBound()), "Wrong LP constraint");

    tmp.upperBound()=n;

    return tmp;

  }

  ///Create constraint

  ///\relates LpBase::Constr

  ///

  inline LpBase::Constr operator>=(const LpBase::Constr &c,

                                   const LpBase::Value &n)

  {

    LpBase::Constr tmp(c);

    LEMON_ASSERT(isNaN(tmp.lowerBound()), "Wrong LP constraint");

    tmp.lowerBound()=n;

    return tmp;

  }

  ///Addition

  ///\relates LpBase::DualExpr

  ///

  inline LpBase::DualExpr operator+(const LpBase::DualExpr &a,

                                    const LpBase::DualExpr &b) {

    LpBase::DualExpr tmp(a);

    tmp+=b;

    return tmp;

  }

  ///Substraction

  ///\relates LpBase::DualExpr

  ///

  inline LpBase::DualExpr operator-(const LpBase::DualExpr &a,

                                    const LpBase::DualExpr &b) {

    LpBase::DualExpr tmp(a);

    tmp-=b;

    return tmp;

  }

  ///Multiply with constant

  ///\relates LpBase::DualExpr

  ///

  inline LpBase::DualExpr operator*(const LpBase::DualExpr &a,

                                    const LpBase::Value &b) {

    LpBase::DualExpr tmp(a);

    tmp*=b;

    return tmp;

  }

  ///Multiply with constant

  ///\relates LpBase::DualExpr

  ///

  inline LpBase::DualExpr operator*(const LpBase::Value &a,

                                    const LpBase::DualExpr &b) {

    LpBase::DualExpr tmp(b);

    tmp*=a;

    return tmp;

  }

  ///Divide with constant

  ///\relates LpBase::DualExpr

  ///

  inline LpBase::DualExpr operator/(const LpBase::DualExpr &a,

                                    const LpBase::Value &b) {

    LpBase::DualExpr tmp(a);

    tmp/=b;

    return tmp;

  }

  /// \ingroup lp_group

  ///

  /// \brief Common base class for LP solvers

  ///

  /// This class is an abstract base class for LP solvers. This class

  /// provides a full interface for set and modify an LP problem,

  /// solve it and retrieve the solution. You can use one of the

  /// descendants as a concrete implementation, or the \c Lp

  /// default LP solver. However, if you would like to handle LP

  /// solvers as reference or pointer in a generic way, you can use

  /// this class directly.

  class LpSolver : virtual public LpBase {

  public:

    /// The problem types for primal and dual problems

    enum ProblemType {

      ///Feasible solution hasn't been found (but may exist).

      UNDEFINED = 0,

      ///The problem has no feasible solution

      INFEASIBLE = 1,

      ///Feasible solution found

      FEASIBLE = 2,

      ///Optimal solution exists and found

      OPTIMAL = 3,

      ///The cost function is unbounded

      UNBOUNDED = 4

    };

    ///The basis status of variables

    enum VarStatus {

      /// The variable is in the basis

      BASIC, 

      /// The variable is free, but not basic

      FREE,

      /// The variable has active lower bound 

      LOWER,

      /// The variable has active upper bound

      UPPER,

      /// The variable is non-basic and fixed

      FIXED

    };

  protected:

    virtual SolveExitStatus _solve() = 0;

    virtual Value _getPrimal(int i) const = 0;

    virtual Value _getDual(int i) const = 0;

    virtual Value _getPrimalRay(int i) const = 0;

    virtual Value _getDualRay(int i) const = 0;

    virtual Value _getPrimalValue() const = 0;

    virtual VarStatus _getColStatus(int i) const = 0;

    virtual VarStatus _getRowStatus(int i) const = 0;

    virtual ProblemType _getPrimalType() const = 0;

    virtual ProblemType _getDualType() const = 0;

  public:

    ///\name Solve the LP

    ///@{

    ///\e Solve the LP problem at hand

    ///

    ///\return The result of the optimization procedure. Possible

    ///values and their meanings can be found in the documentation of

    ///\ref SolveExitStatus.

    SolveExitStatus solve() { return _solve(); }

    ///@}