athos@1247: /* -*- C++ -*-
alpar@1253:  * src/lemon/lp_base.h - Part of LEMON, a generic C++ optimization library
athos@1247:  *
athos@1247:  * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
athos@1247:  * (Egervary Combinatorial Optimization Research Group, EGRES).
athos@1247:  *
athos@1247:  * Permission to use, modify and distribute this software is granted
athos@1247:  * provided that this copyright notice appears in all copies. For
athos@1247:  * precise terms see the accompanying LICENSE file.
athos@1247:  *
athos@1247:  * This software is provided "AS IS" with no warranty of any kind,
athos@1247:  * express or implied, and with no claim as to its suitability for any
athos@1247:  * purpose.
athos@1247:  *
athos@1247:  */
athos@1247: 
athos@1246: #ifndef LEMON_LP_BASE_H
athos@1246: #define LEMON_LP_BASE_H
athos@1246: 
alpar@1253: #include<vector>
alpar@1272: #include<map>
alpar@1256: #include<limits>
alpar@1273: #include<math.h>
alpar@1253: 
alpar@1256: #include<lemon/utility.h>
alpar@1253: #include<lemon/error.h>
alpar@1256: #include<lemon/invalid.h>
alpar@1253: 
alpar@1272: //#include"lin_expr.h"
alpar@1272: 
athos@1246: ///\file
athos@1246: ///\brief The interface of the LP solver interface.
athos@1246: namespace lemon {
alpar@1253:   
alpar@1253:   ///Internal data structure to convert floating id's to fix one's
alpar@1253:     
alpar@1279:   ///\todo This might be implemented to be also usable in other places.
alpar@1253:   class _FixId 
alpar@1253:   {
alpar@1253:     std::vector<int> index;
alpar@1253:     std::vector<int> cross;
alpar@1253:     int first_free;
alpar@1253:   public:
alpar@1253:     _FixId() : first_free(-1) {};
alpar@1253:     ///Convert a floating id to a fix one
alpar@1253: 
alpar@1253:     ///\param n is a floating id
alpar@1253:     ///\return the corresponding fix id
alpar@1253:     int fixId(int n) {return cross[n];}
alpar@1253:     ///Convert a fix id to a floating one
alpar@1253: 
alpar@1253:     ///\param n is a fix id
alpar@1253:     ///\return the corresponding floating id
alpar@1253:     int floatingId(int n) { return index[n];}
alpar@1253:     ///Add a new floating id.
alpar@1253: 
alpar@1253:     ///\param n is a floating id
alpar@1253:     ///\return the fix id of the new value
alpar@1253:     ///\todo Multiple additions should also be handled.
alpar@1253:     int insert(int n)
alpar@1253:     {
alpar@1253:       if(n>=int(cross.size())) {
alpar@1253: 	cross.resize(n+1);
alpar@1253: 	if(first_free==-1) {
alpar@1253: 	  cross[n]=index.size();
alpar@1253: 	  index.push_back(n);
alpar@1253: 	}
alpar@1253: 	else {
alpar@1253: 	  cross[n]=first_free;
alpar@1253: 	  int next=index[first_free];
alpar@1253: 	  index[first_free]=n;
alpar@1253: 	  first_free=next;
alpar@1253: 	}
alpar@1256: 	return cross[n];
alpar@1253:       }
alpar@1273:       ///\todo Create an own exception type.
alpar@1253:       else throw LogicError(); //floatingId-s must form a continuous range;
alpar@1253:     }
alpar@1253:     ///Remove a fix id.
alpar@1253: 
alpar@1253:     ///\param n is a fix id
alpar@1253:     ///
alpar@1253:     void erase(int n) 
alpar@1253:     {
alpar@1253:       int fl=index[n];
alpar@1253:       index[n]=first_free;
alpar@1253:       first_free=n;
alpar@1253:       for(int i=fl+1;i<int(cross.size());++i) {
alpar@1253: 	cross[i-1]=cross[i];
alpar@1253: 	index[cross[i]]--;
alpar@1253:       }
alpar@1253:       cross.pop_back();
alpar@1253:     }
alpar@1253:     ///An upper bound on the largest fix id.
alpar@1253: 
alpar@1253:     ///\todo Do we need this?
alpar@1253:     ///
alpar@1253:     std::size_t maxFixId() { return cross.size()-1; }
alpar@1253:   
alpar@1253:   };
alpar@1253:     
alpar@1253:   ///Common base class for LP solvers
athos@1246:   class LpSolverBase {
alpar@1323: 
athos@1247:   public:
athos@1247: 
alpar@1263:     ///\e
alpar@1303:     enum SolveExitStatus {
alpar@1263:       ///\e
alpar@1293:       SOLVED = 0,
alpar@1263:       ///\e
alpar@1293:       UNSOLVED = 1
athos@1291:     };
athos@1291:       
athos@1291:     ///\e
alpar@1303:     enum SolutionStatus {
alpar@1295:       ///Feasible solution has'n been found (but may exist).
alpar@1295: 
alpar@1295:       ///\todo NOTFOUND might be a better name.
alpar@1295:       ///
alpar@1293:       UNDEFINED = 0,
alpar@1295:       ///The problem has no feasible solution
alpar@1293:       INFEASIBLE = 1,
alpar@1295:       ///Feasible solution found
alpar@1293:       FEASIBLE = 2,
alpar@1295:       ///Optimal solution exists and found
alpar@1295:       OPTIMAL = 3,
alpar@1295:       ///The cost function is unbounded
alpar@1295: 
alpar@1295:       ///\todo Give a feasible solution and an infinite ray (and the
alpar@1295:       ///corresponding bases)
alpar@1295:       INFINITE = 4
alpar@1263:     };
alpar@1263:       
alpar@1256:     ///The floating point type used by the solver
athos@1247:     typedef double Value;
alpar@1256:     ///The infinity constant
athos@1247:     static const Value INF;
alpar@1264:     ///The not a number constant
alpar@1264:     static const Value NaN;
alpar@1253:     
alpar@1256:     ///Refer to a column of the LP.
alpar@1256: 
alpar@1256:     ///This type is used to refer to a column of the LP.
alpar@1256:     ///
alpar@1256:     ///Its value remains valid and correct even after the addition or erase of
alpar@1273:     ///other columns.
alpar@1256:     ///
alpar@1256:     ///\todo Document what can one do with a Col (INVALID, comparing,
alpar@1256:     ///it is similar to Node/Edge)
alpar@1256:     class Col {
alpar@1256:     protected:
alpar@1256:       int id;
alpar@1256:       friend class LpSolverBase;
alpar@1256:     public:
alpar@1259:       typedef Value ExprValue;
alpar@1256:       typedef True LpSolverCol;
alpar@1256:       Col() {}
alpar@1256:       Col(const Invalid&) : id(-1) {}
alpar@1256:       bool operator<(Col c) const  {return id<c.id;}
alpar@1256:       bool operator==(Col c) const  {return id==c.id;}
alpar@1256:       bool operator!=(Col c) const  {return id==c.id;}
alpar@1256:     };
alpar@1256: 
alpar@1256:     ///Refer to a row of the LP.
alpar@1256: 
alpar@1256:     ///This type is used to refer to a row of the LP.
alpar@1256:     ///
alpar@1256:     ///Its value remains valid and correct even after the addition or erase of
alpar@1273:     ///other rows.
alpar@1256:     ///
alpar@1256:     ///\todo Document what can one do with a Row (INVALID, comparing,
alpar@1256:     ///it is similar to Node/Edge)
alpar@1256:     class Row {
alpar@1256:     protected:
alpar@1256:       int id;
alpar@1256:       friend class LpSolverBase;
alpar@1256:     public:
alpar@1259:       typedef Value ExprValue;
alpar@1256:       typedef True LpSolverRow;
alpar@1256:       Row() {}
alpar@1256:       Row(const Invalid&) : id(-1) {}
alpar@1256:       typedef True LpSolverRow;
alpar@1256:       bool operator<(Row c) const  {return id<c.id;}
alpar@1256:       bool operator==(Row c) const  {return id==c.id;}
alpar@1256:       bool operator!=(Row c) const  {return id==c.id;} 
alpar@1256:    };
alpar@1259:     
alpar@1279:     ///Linear expression of variables and a constant component
alpar@1279:     
alpar@1279:     ///This data structure strores a linear expression of the variables
alpar@1279:     ///(\ref Col "Col"s) and also has a constant component.
alpar@1279:     ///
alpar@1279:     ///There are several ways to access and modify the contents of this
alpar@1279:     ///container.
alpar@1279:     ///- Its it fully compatible with \c std::map<Col,double>, so for expamle
alpar@1279:     ///if \c e is an Expr and \c v and \c w are of type \ref Col then you can
alpar@1279:     ///read and modify the coefficients like
alpar@1279:     ///these.
alpar@1279:     ///\code
alpar@1279:     ///e[v]=5;
alpar@1279:     ///e[v]+=12;
alpar@1279:     ///e.erase(v);
alpar@1279:     ///\endcode
alpar@1279:     ///or you can also iterate through its elements.
alpar@1279:     ///\code
alpar@1279:     ///double s=0;
alpar@1279:     ///for(LpSolverBase::Expr::iterator i=e.begin();i!=e.end();++i)
alpar@1279:     ///  s+=i->second;
alpar@1279:     ///\endcode
alpar@1279:     ///(This code computes the sum of all coefficients).
alpar@1279:     ///- Numbers (<tt>double</tt>'s)
alpar@1279:     ///and variables (\ref Col "Col"s) directly convert to an
alpar@1279:     ///\ref Expr and the usual linear operations are defined so  
alpar@1279:     ///\code
alpar@1279:     ///v+w
alpar@1279:     ///2*v-3.12*(v-w/2)+2
alpar@1279:     ///v*2.1+(3*v+(v*12+w+6)*3)/2
alpar@1279:     ///\endcode
alpar@1279:     ///are valid expressions. The usual assignment operations are also defined.
alpar@1279:     ///\code
alpar@1279:     ///e=v+w;
alpar@1279:     ///e+=2*v-3.12*(v-w/2)+2;
alpar@1279:     ///e*=3.4;
alpar@1279:     ///e/=5;
alpar@1279:     ///\endcode
alpar@1279:     ///- The constant member can be set and read by \ref constComp()
alpar@1279:     ///\code
alpar@1279:     ///e.constComp()=12;
alpar@1279:     ///double c=e.constComp();
alpar@1279:     ///\endcode
alpar@1279:     ///
alpar@1279:     ///\note that \ref clear() not only sets all coefficients to 0 but also
alpar@1279:     ///clears the constant components.
alpar@1273:     class Expr : public std::map<Col,Value>
alpar@1272:     {
alpar@1272:     public:
alpar@1273:       typedef LpSolverBase::Col Key; 
alpar@1273:       typedef LpSolverBase::Value Value;
alpar@1272:       
alpar@1272:     protected:
alpar@1273:       typedef std::map<Col,Value> Base;
alpar@1272:       
alpar@1273:       Value const_comp;
alpar@1272:   public:
alpar@1272:       typedef True IsLinExpression;
alpar@1272:       ///\e
alpar@1272:       Expr() : Base(), const_comp(0) { }
alpar@1272:       ///\e
alpar@1273:       Expr(const Key &v) : const_comp(0) {
alpar@1272: 	Base::insert(std::make_pair(v, 1));
alpar@1272:       }
alpar@1272:       ///\e
alpar@1273:       Expr(const Value &v) : const_comp(v) {}
alpar@1272:       ///\e
alpar@1273:       void set(const Key &v,const Value &c) {
alpar@1272: 	Base::insert(std::make_pair(v, c));
alpar@1272:       }
alpar@1272:       ///\e
alpar@1273:       Value &constComp() { return const_comp; }
alpar@1272:       ///\e
alpar@1273:       const Value &constComp() const { return const_comp; }
alpar@1272:       
alpar@1272:       ///Removes the components with zero coefficient.
alpar@1272:       void simplify() {
alpar@1272: 	for (Base::iterator i=Base::begin(); i!=Base::end();) {
alpar@1272: 	  Base::iterator j=i;
alpar@1272: 	  ++j;
alpar@1272: 	  if ((*i).second==0) Base::erase(i);
alpar@1272: 	  j=i;
alpar@1272: 	}
alpar@1272:       }
alpar@1273: 
alpar@1273:       ///Sets all coefficients and the constant component to 0.
alpar@1273:       void clear() {
alpar@1273: 	Base::clear();
alpar@1273: 	const_comp=0;
alpar@1273:       }
alpar@1273: 
alpar@1272:       ///\e
alpar@1272:       Expr &operator+=(const Expr &e) {
alpar@1272: 	for (Base::const_iterator j=e.begin(); j!=e.end(); ++j)
alpar@1272: 	  (*this)[j->first]+=j->second;
alpar@1272: 	///\todo it might be speeded up using "hints"
alpar@1272: 	const_comp+=e.const_comp;
alpar@1272: 	return *this;
alpar@1272:       }
alpar@1272:       ///\e
alpar@1272:       Expr &operator-=(const Expr &e) {
alpar@1272: 	for (Base::const_iterator j=e.begin(); j!=e.end(); ++j)
alpar@1272: 	  (*this)[j->first]-=j->second;
alpar@1272: 	const_comp-=e.const_comp;
alpar@1272: 	return *this;
alpar@1272:       }
alpar@1272:       ///\e
alpar@1273:       Expr &operator*=(const Value &c) {
alpar@1272: 	for (Base::iterator j=Base::begin(); j!=Base::end(); ++j)
alpar@1272: 	  j->second*=c;
alpar@1272: 	const_comp*=c;
alpar@1272: 	return *this;
alpar@1272:       }
alpar@1272:       ///\e
alpar@1273:       Expr &operator/=(const Value &c) {
alpar@1272: 	for (Base::iterator j=Base::begin(); j!=Base::end(); ++j)
alpar@1272: 	  j->second/=c;
alpar@1272: 	const_comp/=c;
alpar@1272: 	return *this;
alpar@1272:       }
alpar@1272:     };
alpar@1272:     
alpar@1264:     ///Linear constraint
alpar@1272:     //typedef LinConstr<Expr> Constr;
alpar@1272:     class Constr
alpar@1272:     {
alpar@1272:     public:
alpar@1272:       typedef LpSolverBase::Expr Expr;
alpar@1273:       typedef Expr::Key Key;
alpar@1273:       typedef Expr::Value Value;
alpar@1272:       
alpar@1273:       static const Value INF;
alpar@1273:       static const Value NaN;
alpar@1273:       //     static const Value INF=0;
alpar@1273:       //     static const Value NaN=1;
alpar@1272:       
alpar@1273:     protected:
alpar@1273:       Expr _expr;
alpar@1273:       Value _lb,_ub;
alpar@1273:     public:
alpar@1273:       ///\e
alpar@1273:       Constr() : _expr(), _lb(NaN), _ub(NaN) {}
alpar@1273:       ///\e
alpar@1273:       Constr(Value lb,const Expr &e,Value ub) :
alpar@1273: 	_expr(e), _lb(lb), _ub(ub) {}
alpar@1273:       ///\e
alpar@1273:       Constr(const Expr &e,Value ub) : 
alpar@1273: 	_expr(e), _lb(NaN), _ub(ub) {}
alpar@1273:       ///\e
alpar@1273:       Constr(Value lb,const Expr &e) :
alpar@1273: 	_expr(e), _lb(lb), _ub(NaN) {}
alpar@1273:       ///\e
alpar@1272:       Constr(const Expr &e) : 
alpar@1273: 	_expr(e), _lb(NaN), _ub(NaN) {}
alpar@1273:       ///\e
alpar@1273:       void clear() 
alpar@1273:       {
alpar@1273: 	_expr.clear();
alpar@1273: 	_lb=_ub=NaN;
alpar@1273:       }
alpar@1273:       ///\e
alpar@1273:       Expr &expr() { return _expr; }
alpar@1273:       ///\e
alpar@1273:       const Expr &expr() const { return _expr; }
alpar@1273:       ///\e
alpar@1273:       Value &lowerBound() { return _lb; }
alpar@1273:       ///\e
alpar@1273:       const Value &lowerBound() const { return _lb; }
alpar@1273:       ///\e
alpar@1273:       Value &upperBound() { return _ub; }
alpar@1273:       ///\e
alpar@1273:       const Value &upperBound() const { return _ub; }
alpar@1275:       ///\e
alpar@1295:       bool lowerBounded() const { 
alpar@1295: 	using namespace std;
alpar@1295: 	return isfinite(_lb);
alpar@1295:       }
alpar@1275:       ///\e
alpar@1295:       bool upperBounded() const {
alpar@1295: 	using namespace std;
alpar@1295: 	return isfinite(_ub);
alpar@1295:       }
alpar@1272:     };
alpar@1272:     
alpar@1253: 
alpar@1253:   protected:
alpar@1253:     _FixId rows;
alpar@1253:     _FixId cols;
athos@1246: 
alpar@1323:     //Abstract virtual functions
athos@1246:     virtual int _addCol() = 0;
athos@1246:     virtual int _addRow() = 0;
athos@1246:     virtual void _setRowCoeffs(int i, 
athos@1251: 			       int length,
athos@1247:                                int  const * indices, 
athos@1247:                                Value  const * values ) = 0;
athos@1246:     virtual void _setColCoeffs(int i, 
athos@1251: 			       int length,
athos@1247:                                int  const * indices, 
athos@1247:                                Value  const * values ) = 0;
alpar@1294:     virtual void _setColLowerBound(int i, Value value) = 0;
alpar@1294:     virtual void _setColUpperBound(int i, Value value) = 0;
alpar@1294:     virtual void _setRowLowerBound(int i, Value value) = 0;
alpar@1294:     virtual void _setRowUpperBound(int i, Value value) = 0;
alpar@1294:     virtual void _setObjCoeff(int i, Value obj_coef) = 0;
alpar@1303:     virtual SolveExitStatus _solve() = 0;
alpar@1294:     virtual Value _getPrimal(int i) = 0;
alpar@1312:     virtual Value _getPrimalValue() = 0;
alpar@1312:     virtual SolutionStatus _getPrimalStatus() = 0;
alpar@1312:     virtual void _setMax() = 0;
alpar@1312:     virtual void _setMin() = 0;
alpar@1312:     
alpar@1323:     //Own protected stuff
alpar@1323:     
alpar@1323:     //Constant component of the objective function
alpar@1323:     Value obj_const_comp;
alpar@1323:     
alpar@1323:     ///\e
alpar@1323:     
alpar@1323:     ///\bug Unimplemented
alpar@1253:     void clearObj() {}
alpar@1323:     
alpar@1253:   public:
alpar@1253: 
alpar@1323:     ///\e
alpar@1323:     LpSolverBase() : obj_const_comp(0) {}
alpar@1253: 
alpar@1253:     ///\e
alpar@1253:     virtual ~LpSolverBase() {}
alpar@1253: 
alpar@1294:     ///\name Build up and modify of the LP
alpar@1263: 
alpar@1263:     ///@{
alpar@1263: 
alpar@1253:     ///Add a new empty column (i.e a new variable) to the LP
alpar@1253:     Col addCol() { Col c; c.id=cols.insert(_addCol()); return c;}
alpar@1263: 
alpar@1294:     ///\brief Adds several new columns
alpar@1294:     ///(i.e a variables) at once
alpar@1256:     ///
alpar@1273:     ///This magic function takes a container as its argument
alpar@1256:     ///and fills its elements
alpar@1256:     ///with new columns (i.e. variables)
alpar@1273:     ///\param t can be
alpar@1273:     ///- a standard STL compatible iterable container with
alpar@1273:     ///\ref Col as its \c values_type
alpar@1273:     ///like
alpar@1273:     ///\code
alpar@1273:     ///std::vector<LpSolverBase::Col>
alpar@1273:     ///std::list<LpSolverBase::Col>
alpar@1273:     ///\endcode
alpar@1273:     ///- a standard STL compatible iterable container with
alpar@1273:     ///\ref Col as its \c mapped_type
alpar@1273:     ///like
alpar@1273:     ///\code
alpar@1312:     ///std::map<AnyStatus,LpSolverBase::Col>
alpar@1273:     ///\endcode
alpar@1273:     ///- an iterable lemon \ref concept::WriteMap "write map" like 
alpar@1273:     ///\code
alpar@1273:     ///ListGraph::NodeMap<LpSolverBase::Col>
alpar@1273:     ///ListGraph::EdgeMap<LpSolverBase::Col>
alpar@1273:     ///\endcode
alpar@1256:     ///\return The number of the created column.
alpar@1256:     ///\bug Iterable nodemap hasn't been implemented yet.
alpar@1256: #ifdef DOXYGEN
alpar@1256:     template<class T>
alpar@1256:     int addColSet(T &t) { return 0;} 
alpar@1256: #else
alpar@1256:     template<class T>
alpar@1256:     typename enable_if<typename T::value_type::LpSolverCol,int>::type
alpar@1256:     addColSet(T &t,dummy<0> = 0) {
alpar@1256:       int s=0;
alpar@1256:       for(typename T::iterator i=t.begin();i!=t.end();++i) {*i=addCol();s++;}
alpar@1256:       return s;
alpar@1256:     }
alpar@1256:     template<class T>
alpar@1256:     typename enable_if<typename T::value_type::second_type::LpSolverCol,
alpar@1256: 		       int>::type
alpar@1256:     addColSet(T &t,dummy<1> = 1) { 
alpar@1256:       int s=0;
alpar@1256:       for(typename T::iterator i=t.begin();i!=t.end();++i) {
alpar@1256: 	i->second=addCol();
alpar@1256: 	s++;
alpar@1256:       }
alpar@1256:       return s;
alpar@1256:     }
alpar@1272:     template<class T>
alpar@1272:     typename enable_if<typename T::ValueSet::value_type::LpSolverCol,
alpar@1272: 		       int>::type
alpar@1272:     addColSet(T &t,dummy<2> = 2) { 
alpar@1272:       ///\bug <tt>return addColSet(t.valueSet());</tt> should also work.
alpar@1272:       int s=0;
alpar@1272:       for(typename T::ValueSet::iterator i=t.valueSet().begin();
alpar@1272: 	  i!=t.valueSet().end();
alpar@1272: 	  ++i)
alpar@1272: 	{
alpar@1272: 	  *i=addCol();
alpar@1272: 	  s++;
alpar@1272: 	}
alpar@1272:       return s;
alpar@1272:     }
alpar@1256: #endif
alpar@1263: 
alpar@1253:     ///Add a new empty row (i.e a new constaint) to the LP
alpar@1258: 
alpar@1258:     ///This function adds a new empty row (i.e a new constaint) to the LP.
alpar@1258:     ///\return The created row
alpar@1253:     Row addRow() { Row r; r.id=rows.insert(_addRow()); return r;}
alpar@1253: 
alpar@1258:     ///Set a row (i.e a constaint) of the LP
alpar@1253: 
alpar@1258:     ///\param r is the row to be modified
alpar@1259:     ///\param l is lower bound (-\ref INF means no bound)
alpar@1258:     ///\param e is a linear expression (see \ref Expr)
alpar@1259:     ///\param u is the upper bound (\ref INF means no bound)
alpar@1253:     ///\bug This is a temportary function. The interface will change to
alpar@1253:     ///a better one.
alpar@1258:     void setRow(Row r, Value l,const Expr &e, Value u) {
alpar@1253:       std::vector<int> indices;
alpar@1253:       std::vector<Value> values;
alpar@1253:       indices.push_back(0);
alpar@1253:       values.push_back(0);
alpar@1258:       for(Expr::const_iterator i=e.begin(); i!=e.end(); ++i)
alpar@1256: 	if((*i).second!=0) { ///\bug EPSILON would be necessary here!!!
alpar@1256: 	  indices.push_back(cols.floatingId((*i).first.id));
alpar@1256: 	  values.push_back((*i).second);
alpar@1256: 	}
alpar@1253:       _setRowCoeffs(rows.floatingId(r.id),indices.size()-1,
alpar@1253: 		    &indices[0],&values[0]);
alpar@1256:       _setRowLowerBound(rows.floatingId(r.id),l-e.constComp());
alpar@1256:       _setRowUpperBound(rows.floatingId(r.id),u-e.constComp());
alpar@1258:     }
alpar@1258: 
alpar@1264:     ///Set a row (i.e a constaint) of the LP
alpar@1264: 
alpar@1264:     ///\param r is the row to be modified
alpar@1264:     ///\param c is a linear expression (see \ref Constr)
alpar@1264:     void setRow(Row r, const Constr &c) {
alpar@1273:       setRow(r,
alpar@1275: 	     c.lowerBounded()?c.lowerBound():-INF,
alpar@1273: 	     c.expr(),
alpar@1275: 	     c.upperBounded()?c.upperBound():INF);
alpar@1264:     }
alpar@1264: 
alpar@1258:     ///Add a new row (i.e a new constaint) to the LP
alpar@1258: 
alpar@1259:     ///\param l is the lower bound (-\ref INF means no bound)
alpar@1258:     ///\param e is a linear expression (see \ref Expr)
alpar@1259:     ///\param u is the upper bound (\ref INF means no bound)
alpar@1258:     ///\return The created row.
alpar@1258:     ///\bug This is a temportary function. The interface will change to
alpar@1258:     ///a better one.
alpar@1258:     Row addRow(Value l,const Expr &e, Value u) {
alpar@1258:       Row r=addRow();
alpar@1258:       setRow(r,l,e,u);
alpar@1253:       return r;
alpar@1253:     }
alpar@1253: 
alpar@1264:     ///Add a new row (i.e a new constaint) to the LP
alpar@1264: 
alpar@1264:     ///\param c is a linear expression (see \ref Constr)
alpar@1264:     ///\return The created row.
alpar@1264:     Row addRow(const Constr &c) {
alpar@1264:       Row r=addRow();
alpar@1264:       setRow(r,c);
alpar@1264:       return r;
alpar@1264:     }
alpar@1264: 
alpar@1253:     /// Set the lower bound of a column (i.e a variable)
alpar@1253: 
alpar@1293:     /// The upper bound of a variable (column) has to be given by an 
alpar@1253:     /// extended number of type Value, i.e. a finite number of type 
alpar@1259:     /// Value or -\ref INF.
alpar@1293:     void colLowerBound(Col c, Value value) {
alpar@1253:       _setColLowerBound(cols.floatingId(c.id),value);
alpar@1253:     }
alpar@1253:     /// Set the upper bound of a column (i.e a variable)
alpar@1253: 
alpar@1293:     /// The upper bound of a variable (column) has to be given by an 
alpar@1253:     /// extended number of type Value, i.e. a finite number of type 
alpar@1259:     /// Value or \ref INF.
alpar@1293:     void colUpperBound(Col c, Value value) {
alpar@1253:       _setColUpperBound(cols.floatingId(c.id),value);
alpar@1253:     };
alpar@1293:     /// Set the lower and the upper bounds of a column (i.e a variable)
alpar@1293: 
alpar@1293:     /// The lower and the upper bounds of
alpar@1293:     /// a variable (column) have to be given by an 
alpar@1293:     /// extended number of type Value, i.e. a finite number of type 
alpar@1293:     /// Value, -\ref INF or \ref INF.
alpar@1293:     void colBounds(Col c, Value lower, Value upper) {
alpar@1293:       _setColLowerBound(cols.floatingId(c.id),lower);
alpar@1293:       _setColUpperBound(cols.floatingId(c.id),upper);
alpar@1293:     }
alpar@1293:     
alpar@1253:     /// Set the lower bound of a row (i.e a constraint)
alpar@1253: 
alpar@1293:     /// The lower bound of a linear expression (row) has to be given by an 
alpar@1253:     /// extended number of type Value, i.e. a finite number of type 
alpar@1259:     /// Value or -\ref INF.
alpar@1293:     void rowLowerBound(Row r, Value value) {
alpar@1253:       _setRowLowerBound(rows.floatingId(r.id),value);
alpar@1253:     };
alpar@1253:     /// Set the upper bound of a row (i.e a constraint)
alpar@1253: 
alpar@1293:     /// The upper bound of a linear expression (row) has to be given by an 
alpar@1253:     /// extended number of type Value, i.e. a finite number of type 
alpar@1259:     /// Value or \ref INF.
alpar@1293:     void rowUpperBound(Row r, Value value) {
alpar@1253:       _setRowUpperBound(rows.floatingId(r.id),value);
alpar@1253:     };
alpar@1293:     /// Set the lower and the upper bounds of a row (i.e a variable)
alpar@1293: 
alpar@1293:     /// The lower and the upper bounds of
alpar@1293:     /// a constraint (row) have to be given by an 
alpar@1293:     /// extended number of type Value, i.e. a finite number of type 
alpar@1293:     /// Value, -\ref INF or \ref INF.
alpar@1293:     void rowBounds(Row c, Value lower, Value upper) {
alpar@1293:       _setRowLowerBound(rows.floatingId(c.id),lower);
alpar@1293:       _setRowUpperBound(rows.floatingId(c.id),upper);
alpar@1293:     }
alpar@1293:     
alpar@1253:     ///Set an element of the objective function
alpar@1293:     void objCoeff(Col c, Value v) {_setObjCoeff(cols.floatingId(c.id),v); };
alpar@1253:     ///Set the objective function
alpar@1253:     
alpar@1253:     ///\param e is a linear expression of type \ref Expr.
alpar@1323:     ///\bug The previous objective function is not cleared!
alpar@1253:     void setObj(Expr e) {
alpar@1253:       clearObj();
alpar@1253:       for (Expr::iterator i=e.begin(); i!=e.end(); ++i)
alpar@1293: 	objCoeff((*i).first,(*i).second);
alpar@1323:       obj_const_comp=e.constComp();
alpar@1253:     }
alpar@1263: 
alpar@1312:     ///Maximize
alpar@1312:     void max() { _setMax(); }
alpar@1312:     ///Minimize
alpar@1312:     void min() { _setMin(); }
alpar@1312: 
alpar@1312:     
alpar@1263:     ///@}
alpar@1263: 
alpar@1263: 
alpar@1294:     ///\name Solve the LP
alpar@1263: 
alpar@1263:     ///@{
alpar@1263: 
alpar@1263:     ///\e
alpar@1303:     SolveExitStatus solve() { return _solve(); }
alpar@1263:     
alpar@1263:     ///@}
alpar@1263:     
alpar@1294:     ///\name Obtain the solution
alpar@1263: 
alpar@1263:     ///@{
alpar@1263: 
alpar@1263:     ///\e
alpar@1312:     SolutionStatus primalStatus() {
alpar@1312:       return _getPrimalStatus();
alpar@1294:     }
alpar@1294: 
alpar@1294:     ///\e
alpar@1293:     Value primal(Col c) { return _getPrimal(cols.floatingId(c.id)); }
alpar@1263: 
alpar@1312:     ///\e
alpar@1312: 
alpar@1312:     ///\return
alpar@1312:     ///- \ref INF or -\ref INF means either infeasibility or unboundedness
alpar@1312:     /// of the primal problem, depending on whether we minimize or maximize.
alpar@1312:     ///- \ref NAN if no primal solution is found.
alpar@1312:     ///- The (finite) objective value if an optimal solution is found.
alpar@1323:     Value primalValue() { return _getPrimalValue()+obj_const_comp;}
alpar@1263:     ///@}
alpar@1253:     
athos@1248:   };  
athos@1246: 
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Expr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Expr operator+(const LpSolverBase::Expr &a,
alpar@1272: 				      const LpSolverBase::Expr &b) 
alpar@1272:   {
alpar@1272:     LpSolverBase::Expr tmp(a);
alpar@1272:     tmp+=b; ///\todo Don't STL have some special 'merge' algorithm?
alpar@1272:     return tmp;
alpar@1272:   }
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Expr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Expr operator-(const LpSolverBase::Expr &a,
alpar@1272: 				      const LpSolverBase::Expr &b) 
alpar@1272:   {
alpar@1272:     LpSolverBase::Expr tmp(a);
alpar@1272:     tmp-=b; ///\todo Don't STL have some special 'merge' algorithm?
alpar@1272:     return tmp;
alpar@1272:   }
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Expr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Expr operator*(const LpSolverBase::Expr &a,
alpar@1273: 				      const LpSolverBase::Value &b) 
alpar@1272:   {
alpar@1272:     LpSolverBase::Expr tmp(a);
alpar@1272:     tmp*=b; ///\todo Don't STL have some special 'merge' algorithm?
alpar@1272:     return tmp;
alpar@1272:   }
alpar@1272:   
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Expr
alpar@1272:   ///
alpar@1273:   inline LpSolverBase::Expr operator*(const LpSolverBase::Value &a,
alpar@1272: 				      const LpSolverBase::Expr &b) 
alpar@1272:   {
alpar@1272:     LpSolverBase::Expr tmp(b);
alpar@1272:     tmp*=a; ///\todo Don't STL have some special 'merge' algorithm?
alpar@1272:     return tmp;
alpar@1272:   }
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Expr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Expr operator/(const LpSolverBase::Expr &a,
alpar@1273: 				      const LpSolverBase::Value &b) 
alpar@1272:   {
alpar@1272:     LpSolverBase::Expr tmp(a);
alpar@1272:     tmp/=b; ///\todo Don't STL have some special 'merge' algorithm?
alpar@1272:     return tmp;
alpar@1272:   }
alpar@1272:   
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Constr operator<=(const LpSolverBase::Expr &e,
alpar@1272: 					 const LpSolverBase::Expr &f) 
alpar@1272:   {
alpar@1272:     return LpSolverBase::Constr(-LpSolverBase::INF,e-f,0);
alpar@1272:   }
alpar@1272: 
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1273:   inline LpSolverBase::Constr operator<=(const LpSolverBase::Value &e,
alpar@1272: 					 const LpSolverBase::Expr &f) 
alpar@1272:   {
alpar@1272:     return LpSolverBase::Constr(e,f);
alpar@1272:   }
alpar@1272: 
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Constr operator<=(const LpSolverBase::Expr &e,
alpar@1273: 					 const LpSolverBase::Value &f) 
alpar@1272:   {
alpar@1272:     return LpSolverBase::Constr(e,f);
alpar@1272:   }
alpar@1272: 
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Constr operator>=(const LpSolverBase::Expr &e,
alpar@1272: 					 const LpSolverBase::Expr &f) 
alpar@1272:   {
alpar@1272:     return LpSolverBase::Constr(-LpSolverBase::INF,f-e,0);
alpar@1272:   }
alpar@1272: 
alpar@1272: 
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1273:   inline LpSolverBase::Constr operator>=(const LpSolverBase::Value &e,
alpar@1272: 					 const LpSolverBase::Expr &f) 
alpar@1272:   {
alpar@1272:     return LpSolverBase::Constr(f,e);
alpar@1272:   }
alpar@1272: 
alpar@1272: 
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Constr operator>=(const LpSolverBase::Expr &e,
alpar@1273: 					 const LpSolverBase::Value &f) 
alpar@1272:   {
alpar@1272:     return LpSolverBase::Constr(f,e);
alpar@1272:   }
alpar@1272: 
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Constr operator==(const LpSolverBase::Expr &e,
alpar@1272: 					 const LpSolverBase::Expr &f) 
alpar@1272:   {
alpar@1272:     return LpSolverBase::Constr(0,e-f,0);
alpar@1272:   }
alpar@1272: 
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1273:   inline LpSolverBase::Constr operator<=(const LpSolverBase::Value &n,
alpar@1272: 					 const LpSolverBase::Constr&c) 
alpar@1272:   {
alpar@1272:     LpSolverBase::Constr tmp(c);
alpar@1273:     ///\todo Create an own exception type.
alpar@1273:     if(!isnan(tmp.lowerBound())) throw LogicError();
alpar@1273:     else tmp.lowerBound()=n;
alpar@1272:     return tmp;
alpar@1272:   }
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Constr operator<=(const LpSolverBase::Constr& c,
alpar@1273: 					 const LpSolverBase::Value &n)
alpar@1272:   {
alpar@1272:     LpSolverBase::Constr tmp(c);
alpar@1273:     ///\todo Create an own exception type.
alpar@1273:     if(!isnan(tmp.upperBound())) throw LogicError();
alpar@1273:     else tmp.upperBound()=n;
alpar@1272:     return tmp;
alpar@1272:   }
alpar@1272: 
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1273:   inline LpSolverBase::Constr operator>=(const LpSolverBase::Value &n,
alpar@1272: 					 const LpSolverBase::Constr&c) 
alpar@1272:   {
alpar@1272:     LpSolverBase::Constr tmp(c);
alpar@1273:     ///\todo Create an own exception type.
alpar@1273:     if(!isnan(tmp.upperBound())) throw LogicError();
alpar@1273:     else tmp.upperBound()=n;
alpar@1272:     return tmp;
alpar@1272:   }
alpar@1272:   ///\e
alpar@1272:   
alpar@1272:   ///\relates LpSolverBase::Constr
alpar@1272:   ///
alpar@1272:   inline LpSolverBase::Constr operator>=(const LpSolverBase::Constr& c,
alpar@1273: 					 const LpSolverBase::Value &n)
alpar@1272:   {
alpar@1272:     LpSolverBase::Constr tmp(c);
alpar@1273:     ///\todo Create an own exception type.
alpar@1273:     if(!isnan(tmp.lowerBound())) throw LogicError();
alpar@1273:     else tmp.lowerBound()=n;
alpar@1272:     return tmp;
alpar@1272:   }
alpar@1272: 
alpar@1272: 
athos@1246: } //namespace lemon
athos@1246: 
athos@1246: #endif //LEMON_LP_BASE_H