lemon/lp_base.h
author deba
Mon, 17 Dec 2007 09:54:26 +0000
changeset 2542 faaa54ec4520
parent 2495 e4f8367beb41
child 2553 bfced05fa852
permissions -rw-r--r--
Bug fix
     1 /* -*- C++ -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library
     4  *
     5  * Copyright (C) 2003-2007
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8  *
     9  * Permission to use, modify and distribute this software is granted
    10  * provided that this copyright notice appears in all copies. For
    11  * precise terms see the accompanying LICENSE file.
    12  *
    13  * This software is provided "AS IS" with no warranty of any kind,
    14  * express or implied, and with no claim as to its suitability for any
    15  * purpose.
    16  *
    17  */
    18 
    19 #ifndef LEMON_LP_BASE_H
    20 #define LEMON_LP_BASE_H
    21 
    22 #include<iostream>
    23 #include<vector>
    24 #include<map>
    25 #include<limits>
    26 #include<cmath>
    27 
    28 #include<lemon/error.h>
    29 #include<lemon/bits/invalid.h>
    30 #include<lemon/bits/utility.h>
    31 #include<lemon/bits/lp_id.h>
    32 
    33 ///\file
    34 ///\brief The interface of the LP solver interface.
    35 ///\ingroup lp_group
    36 namespace lemon {
    37 
    38   /// Function to decide whether a floating point value is finite or not.
    39 
    40   /// Retruns true if the argument is not infinity, minus infinity or NaN.
    41   /// It does the same as the isfinite() function defined by C99.
    42   template <typename T>
    43   bool isFinite(T value)
    44   {
    45     typedef std::numeric_limits<T> Lim;
    46     if (Lim::has_infinity && (value == Lim::infinity() || value ==
    47           -Lim::infinity()) ||
    48         (Lim::has_quiet_NaN || Lim::has_signaling_NaN) && value != value)
    49     {
    50       return false;
    51     }
    52     return true;
    53   }
    54 
    55   ///Common base class for LP solvers
    56   
    57   ///\todo Much more docs
    58   ///\ingroup lp_group
    59   class LpSolverBase {
    60 
    61   protected:
    62 
    63     _lp_bits::LpId rows;
    64     _lp_bits::LpId cols;
    65     
    66   public:
    67     
    68     ///Possible outcomes of an LP solving procedure
    69     enum SolveExitStatus {
    70       ///This means that the problem has been successfully solved: either
    71       ///an optimal solution has been found or infeasibility/unboundedness
    72       ///has been proved.
    73       SOLVED = 0,
    74       ///Any other case (including the case when some user specified
    75       ///limit has been exceeded)
    76       UNSOLVED = 1
    77     };
    78       
    79       ///\e
    80     enum SolutionStatus {
    81       ///Feasible solution hasn't been found (but may exist).
    82 
    83       ///\todo NOTFOUND might be a better name.
    84       ///
    85       UNDEFINED = 0,
    86       ///The problem has no feasible solution
    87       INFEASIBLE = 1,
    88       ///Feasible solution found
    89       FEASIBLE = 2,
    90       ///Optimal solution exists and found
    91       OPTIMAL = 3,
    92       ///The cost function is unbounded
    93 
    94       ///\todo Give a feasible solution and an infinite ray (and the
    95       ///corresponding bases)
    96       INFINITE = 4
    97     };
    98 
    99     ///\e The type of the investigated LP problem
   100     enum ProblemTypes {
   101       ///Primal-dual feasible
   102       PRIMAL_DUAL_FEASIBLE = 0,
   103       ///Primal feasible dual infeasible
   104       PRIMAL_FEASIBLE_DUAL_INFEASIBLE = 1,
   105       ///Primal infeasible dual feasible
   106       PRIMAL_INFEASIBLE_DUAL_FEASIBLE = 2,
   107       ///Primal-dual infeasible
   108       PRIMAL_DUAL_INFEASIBLE = 3,
   109       ///Could not determine so far
   110       UNKNOWN = 4
   111     };
   112 
   113     ///The floating point type used by the solver
   114     typedef double Value;
   115     ///The infinity constant
   116     static const Value INF;
   117     ///The not a number constant
   118     static const Value NaN;
   119 
   120     static inline bool isNaN(const Value& v) { return v!=v; }
   121     
   122     friend class Col;
   123     friend class ColIt;
   124     friend class Row;
   125     
   126     ///Refer to a column of the LP.
   127 
   128     ///This type is used to refer to a column of the LP.
   129     ///
   130     ///Its value remains valid and correct even after the addition or erase of
   131     ///other columns.
   132     ///
   133     ///\todo Document what can one do with a Col (INVALID, comparing,
   134     ///it is similar to Node/Edge)
   135     class Col {
   136     protected:
   137       int id;
   138       friend class LpSolverBase;
   139       friend class MipSolverBase;
   140       explicit Col(int _id) : id(_id) {}
   141     public:
   142       typedef Value ExprValue;
   143       typedef True LpSolverCol;
   144       Col() {}
   145       Col(const Invalid&) : id(-1) {}
   146       bool operator< (Col c) const  {return id< c.id;}
   147       bool operator> (Col c) const  {return id> c.id;}
   148       bool operator==(Col c) const  {return id==c.id;}
   149       bool operator!=(Col c) const  {return id!=c.id;}
   150     };
   151 
   152     class ColIt : public Col {
   153       const LpSolverBase *_lp;
   154     public:
   155       ColIt() {}
   156       ColIt(const LpSolverBase &lp) : _lp(&lp)
   157       {
   158         _lp->cols.firstFix(id);
   159       }
   160       ColIt(const Invalid&) : Col(INVALID) {}
   161       ColIt &operator++() 
   162       {
   163         _lp->cols.nextFix(id);
   164 	return *this;
   165       }
   166     };
   167 
   168     static int id(const Col& col) { return col.id; }
   169  
   170       
   171     ///Refer to a row of the LP.
   172 
   173     ///This type is used to refer to a row of the LP.
   174     ///
   175     ///Its value remains valid and correct even after the addition or erase of
   176     ///other rows.
   177     ///
   178     ///\todo Document what can one do with a Row (INVALID, comparing,
   179     ///it is similar to Node/Edge)
   180     class Row {
   181     protected:
   182       int id;
   183       friend class LpSolverBase;
   184       explicit Row(int _id) : id(_id) {}
   185     public:
   186       typedef Value ExprValue;
   187       typedef True LpSolverRow;
   188       Row() {}
   189       Row(const Invalid&) : id(-1) {}
   190 
   191       bool operator< (Row c) const  {return id< c.id;}
   192       bool operator> (Row c) const  {return id> c.id;}
   193       bool operator==(Row c) const  {return id==c.id;}
   194       bool operator!=(Row c) const  {return id!=c.id;} 
   195     };
   196 
   197     class RowIt : public Row {
   198       const LpSolverBase *_lp;
   199     public:
   200       RowIt() {}
   201       RowIt(const LpSolverBase &lp) : _lp(&lp)
   202       {
   203         _lp->rows.firstFix(id);
   204       }
   205       RowIt(const Invalid&) : Row(INVALID) {}
   206       RowIt &operator++() 
   207       {
   208         _lp->rows.nextFix(id);
   209 	return *this;
   210       }
   211     };
   212 
   213     static int id(const Row& row) { return row.id; }
   214 
   215   protected:
   216 
   217     int _lpId(const Col& c) const {
   218       return cols.floatingId(id(c));
   219     }
   220 
   221     int _lpId(const Row& r) const {
   222       return rows.floatingId(id(r));
   223     }
   224 
   225     Col _item(int i, Col) const {
   226       return Col(cols.fixId(i));
   227     }
   228 
   229     Row _item(int i, Row) const {
   230       return Row(rows.fixId(i));
   231     }
   232 
   233 
   234   public:
   235     
   236     ///Linear expression of variables and a constant component
   237     
   238     ///This data structure stores a linear expression of the variables
   239     ///(\ref Col "Col"s) and also has a constant component.
   240     ///
   241     ///There are several ways to access and modify the contents of this
   242     ///container.
   243     ///- Its it fully compatible with \c std::map<Col,double>, so for expamle
   244     ///if \c e is an Expr and \c v and \c w are of type \ref Col, then you can
   245     ///read and modify the coefficients like
   246     ///these.
   247     ///\code
   248     ///e[v]=5;
   249     ///e[v]+=12;
   250     ///e.erase(v);
   251     ///\endcode
   252     ///or you can also iterate through its elements.
   253     ///\code
   254     ///double s=0;
   255     ///for(LpSolverBase::Expr::iterator i=e.begin();i!=e.end();++i)
   256     ///  s+=i->second;
   257     ///\endcode
   258     ///(This code computes the sum of all coefficients).
   259     ///- Numbers (<tt>double</tt>'s)
   260     ///and variables (\ref Col "Col"s) directly convert to an
   261     ///\ref Expr and the usual linear operations are defined, so  
   262     ///\code
   263     ///v+w
   264     ///2*v-3.12*(v-w/2)+2
   265     ///v*2.1+(3*v+(v*12+w+6)*3)/2
   266     ///\endcode
   267     ///are valid \ref Expr "Expr"essions.
   268     ///The usual assignment operations are also defined.
   269     ///\code
   270     ///e=v+w;
   271     ///e+=2*v-3.12*(v-w/2)+2;
   272     ///e*=3.4;
   273     ///e/=5;
   274     ///\endcode
   275     ///- The constant member can be set and read by \ref constComp()
   276     ///\code
   277     ///e.constComp()=12;
   278     ///double c=e.constComp();
   279     ///\endcode
   280     ///
   281     ///\note \ref clear() not only sets all coefficients to 0 but also
   282     ///clears the constant components.
   283     ///
   284     ///\sa Constr
   285     ///
   286     class Expr : public std::map<Col,Value>
   287     {
   288     public:
   289       typedef LpSolverBase::Col Key; 
   290       typedef LpSolverBase::Value Value;
   291       
   292     protected:
   293       typedef std::map<Col,Value> Base;
   294       
   295       Value const_comp;
   296     public:
   297       typedef True IsLinExpression;
   298       ///\e
   299       Expr() : Base(), const_comp(0) { }
   300       ///\e
   301       Expr(const Key &v) : const_comp(0) {
   302 	Base::insert(std::make_pair(v, 1));
   303       }
   304       ///\e
   305       Expr(const Value &v) : const_comp(v) {}
   306       ///\e
   307       void set(const Key &v,const Value &c) {
   308 	Base::insert(std::make_pair(v, c));
   309       }
   310       ///\e
   311       Value &constComp() { return const_comp; }
   312       ///\e
   313       const Value &constComp() const { return const_comp; }
   314       
   315       ///Removes the components with zero coefficient.
   316       void simplify() {
   317 	for (Base::iterator i=Base::begin(); i!=Base::end();) {
   318 	  Base::iterator j=i;
   319 	  ++j;
   320 	  if ((*i).second==0) Base::erase(i);
   321 	  i=j;
   322 	}
   323       }
   324 
   325       void simplify() const {
   326         const_cast<Expr*>(this)->simplify();
   327       }
   328 
   329       ///Removes the coefficients closer to zero than \c tolerance.
   330       void simplify(double &tolerance) {
   331 	for (Base::iterator i=Base::begin(); i!=Base::end();) {
   332 	  Base::iterator j=i;
   333 	  ++j;
   334 	  if (std::fabs((*i).second)<tolerance) Base::erase(i);
   335 	  i=j;
   336 	}
   337       }
   338 
   339       ///Sets all coefficients and the constant component to 0.
   340       void clear() {
   341 	Base::clear();
   342 	const_comp=0;
   343       }
   344 
   345       ///\e
   346       Expr &operator+=(const Expr &e) {
   347 	for (Base::const_iterator j=e.begin(); j!=e.end(); ++j)
   348 	  (*this)[j->first]+=j->second;
   349 	const_comp+=e.const_comp;
   350 	return *this;
   351       }
   352       ///\e
   353       Expr &operator-=(const Expr &e) {
   354 	for (Base::const_iterator j=e.begin(); j!=e.end(); ++j)
   355 	  (*this)[j->first]-=j->second;
   356 	const_comp-=e.const_comp;
   357 	return *this;
   358       }
   359       ///\e
   360       Expr &operator*=(const Value &c) {
   361 	for (Base::iterator j=Base::begin(); j!=Base::end(); ++j)
   362 	  j->second*=c;
   363 	const_comp*=c;
   364 	return *this;
   365       }
   366       ///\e
   367       Expr &operator/=(const Value &c) {
   368 	for (Base::iterator j=Base::begin(); j!=Base::end(); ++j)
   369 	  j->second/=c;
   370 	const_comp/=c;
   371 	return *this;
   372       }
   373 
   374       //std::ostream &
   375       void prettyPrint(std::ostream &os) {
   376 	//std::fmtflags os.flags();
   377 	//os.setf(std::ios::showpos);
   378 	Base::iterator j=Base::begin();
   379 	if (j!=Base::end())
   380 	  os<<j->second<<"*x["<<id(j->first)<<"]";
   381 	++j;
   382 	for (; j!=Base::end(); ++j){
   383 	  if (j->second>=0)
   384 	    os<<"+";
   385 	  os<<j->second<<"*x["<<id(j->first)<<"]";
   386 	}
   387 	//Nem valami korrekt, de nem talaltam meg, hogy kell
   388 	//os.unsetf(std::ios::showpos);
   389 
   390 	//return os;
   391       }
   392 
   393     };
   394     
   395     ///Linear constraint
   396 
   397     ///This data stucture represents a linear constraint in the LP.
   398     ///Basically it is a linear expression with a lower or an upper bound
   399     ///(or both). These parts of the constraint can be obtained by the member
   400     ///functions \ref expr(), \ref lowerBound() and \ref upperBound(),
   401     ///respectively.
   402     ///There are two ways to construct a constraint.
   403     ///- You can set the linear expression and the bounds directly
   404     ///  by the functions above.
   405     ///- The operators <tt>\<=</tt>, <tt>==</tt> and  <tt>\>=</tt>
   406     ///  are defined between expressions, or even between constraints whenever
   407     ///  it makes sense. Therefore if \c e and \c f are linear expressions and
   408     ///  \c s and \c t are numbers, then the followings are valid expressions
   409     ///  and thus they can be used directly e.g. in \ref addRow() whenever
   410     ///  it makes sense.
   411     ///\code
   412     ///  e<=s
   413     ///  e<=f
   414     ///  e==f
   415     ///  s<=e<=t
   416     ///  e>=t
   417     ///\endcode
   418     ///\warning The validity of a constraint is checked only at run time, so
   419     ///e.g. \ref addRow(<tt>x[1]\<=x[2]<=5</tt>) will compile, but will throw a
   420     ///\ref LogicError exception.
   421     class Constr
   422     {
   423     public:
   424       typedef LpSolverBase::Expr Expr;
   425       typedef Expr::Key Key;
   426       typedef Expr::Value Value;
   427       
   428     protected:
   429       Expr _expr;
   430       Value _lb,_ub;
   431     public:
   432       ///\e
   433       Constr() : _expr(), _lb(NaN), _ub(NaN) {}
   434       ///\e
   435       Constr(Value lb,const Expr &e,Value ub) :
   436 	_expr(e), _lb(lb), _ub(ub) {}
   437       ///\e
   438       Constr(const Expr &e,Value ub) : 
   439 	_expr(e), _lb(NaN), _ub(ub) {}
   440       ///\e
   441       Constr(Value lb,const Expr &e) :
   442 	_expr(e), _lb(lb), _ub(NaN) {}
   443       ///\e
   444       Constr(const Expr &e) : 
   445 	_expr(e), _lb(NaN), _ub(NaN) {}
   446       ///\e
   447       void clear() 
   448       {
   449 	_expr.clear();
   450 	_lb=_ub=NaN;
   451       }
   452 
   453       ///Reference to the linear expression 
   454       Expr &expr() { return _expr; }
   455       ///Cont reference to the linear expression 
   456       const Expr &expr() const { return _expr; }
   457       ///Reference to the lower bound.
   458 
   459       ///\return
   460       ///- \ref INF "INF": the constraint is lower unbounded.
   461       ///- \ref NaN "NaN": lower bound has not been set.
   462       ///- finite number: the lower bound
   463       Value &lowerBound() { return _lb; }
   464       ///The const version of \ref lowerBound()
   465       const Value &lowerBound() const { return _lb; }
   466       ///Reference to the upper bound.
   467 
   468       ///\return
   469       ///- \ref INF "INF": the constraint is upper unbounded.
   470       ///- \ref NaN "NaN": upper bound has not been set.
   471       ///- finite number: the upper bound
   472       Value &upperBound() { return _ub; }
   473       ///The const version of \ref upperBound()
   474       const Value &upperBound() const { return _ub; }
   475       ///Is the constraint lower bounded?
   476       bool lowerBounded() const { 
   477 	return isFinite(_lb);
   478       }
   479       ///Is the constraint upper bounded?
   480       bool upperBounded() const {
   481 	return isFinite(_ub);
   482       }
   483 
   484       void prettyPrint(std::ostream &os) {
   485 	if (_lb==-LpSolverBase::INF||isNaN(_lb))
   486 	  os<<"-infty<=";
   487 	else
   488 	  os<<_lb<<"<=";
   489 	_expr.prettyPrint(os);
   490 	if (_ub==LpSolverBase::INF)
   491 	  os<<"<=infty";
   492 	else
   493 	  os<<"<="<<_ub;
   494 	//return os;
   495       }
   496 
   497     };
   498     
   499     ///Linear expression of rows
   500     
   501     ///This data structure represents a column of the matrix,
   502     ///thas is it strores a linear expression of the dual variables
   503     ///(\ref Row "Row"s).
   504     ///
   505     ///There are several ways to access and modify the contents of this
   506     ///container.
   507     ///- Its it fully compatible with \c std::map<Row,double>, so for expamle
   508     ///if \c e is an DualExpr and \c v
   509     ///and \c w are of type \ref Row, then you can
   510     ///read and modify the coefficients like
   511     ///these.
   512     ///\code
   513     ///e[v]=5;
   514     ///e[v]+=12;
   515     ///e.erase(v);
   516     ///\endcode
   517     ///or you can also iterate through its elements.
   518     ///\code
   519     ///double s=0;
   520     ///for(LpSolverBase::DualExpr::iterator i=e.begin();i!=e.end();++i)
   521     ///  s+=i->second;
   522     ///\endcode
   523     ///(This code computes the sum of all coefficients).
   524     ///- Numbers (<tt>double</tt>'s)
   525     ///and variables (\ref Row "Row"s) directly convert to an
   526     ///\ref DualExpr and the usual linear operations are defined, so
   527     ///\code
   528     ///v+w
   529     ///2*v-3.12*(v-w/2)
   530     ///v*2.1+(3*v+(v*12+w)*3)/2
   531     ///\endcode
   532     ///are valid \ref DualExpr "DualExpr"essions.
   533     ///The usual assignment operations are also defined.
   534     ///\code
   535     ///e=v+w;
   536     ///e+=2*v-3.12*(v-w/2);
   537     ///e*=3.4;
   538     ///e/=5;
   539     ///\endcode
   540     ///
   541     ///\sa Expr
   542     ///
   543     class DualExpr : public std::map<Row,Value>
   544     {
   545     public:
   546       typedef LpSolverBase::Row Key; 
   547       typedef LpSolverBase::Value Value;
   548       
   549     protected:
   550       typedef std::map<Row,Value> Base;
   551       
   552     public:
   553       typedef True IsLinExpression;
   554       ///\e
   555       DualExpr() : Base() { }
   556       ///\e
   557       DualExpr(const Key &v) {
   558 	Base::insert(std::make_pair(v, 1));
   559       }
   560       ///\e
   561       void set(const Key &v,const Value &c) {
   562 	Base::insert(std::make_pair(v, c));
   563       }
   564       
   565       ///Removes the components with zero coefficient.
   566       void simplify() {
   567 	for (Base::iterator i=Base::begin(); i!=Base::end();) {
   568 	  Base::iterator j=i;
   569 	  ++j;
   570 	  if ((*i).second==0) Base::erase(i);
   571 	  i=j;
   572 	}
   573       }
   574 
   575       void simplify() const {
   576         const_cast<DualExpr*>(this)->simplify();
   577       }
   578 
   579       ///Removes the coefficients closer to zero than \c tolerance.
   580       void simplify(double &tolerance) {
   581 	for (Base::iterator i=Base::begin(); i!=Base::end();) {
   582 	  Base::iterator j=i;
   583 	  ++j;
   584 	  if (std::fabs((*i).second)<tolerance) Base::erase(i);
   585 	  i=j;
   586 	}
   587       }
   588 
   589       ///Sets all coefficients to 0.
   590       void clear() {
   591 	Base::clear();
   592       }
   593 
   594       ///\e
   595       DualExpr &operator+=(const DualExpr &e) {
   596 	for (Base::const_iterator j=e.begin(); j!=e.end(); ++j)
   597 	  (*this)[j->first]+=j->second;
   598 	return *this;
   599       }
   600       ///\e
   601       DualExpr &operator-=(const DualExpr &e) {
   602 	for (Base::const_iterator j=e.begin(); j!=e.end(); ++j)
   603 	  (*this)[j->first]-=j->second;
   604 	return *this;
   605       }
   606       ///\e
   607       DualExpr &operator*=(const Value &c) {
   608 	for (Base::iterator j=Base::begin(); j!=Base::end(); ++j)
   609 	  j->second*=c;
   610 	return *this;
   611       }
   612       ///\e
   613       DualExpr &operator/=(const Value &c) {
   614 	for (Base::iterator j=Base::begin(); j!=Base::end(); ++j)
   615 	  j->second/=c;
   616 	return *this;
   617       }
   618     };
   619     
   620 
   621   private:
   622 
   623     template <typename _Expr>
   624     class MappedOutputIterator {
   625     public:
   626 
   627       typedef std::insert_iterator<_Expr> Base;
   628 
   629       typedef std::output_iterator_tag iterator_category;
   630       typedef void difference_type;
   631       typedef void value_type;
   632       typedef void reference;
   633       typedef void pointer;
   634       
   635       MappedOutputIterator(const Base& _base, const LpSolverBase& _lp) 
   636         : base(_base), lp(_lp) {}
   637 
   638       MappedOutputIterator& operator*() {
   639         return *this;
   640       }
   641 
   642       MappedOutputIterator& operator=(const std::pair<int, Value>& value) {
   643         *base = std::make_pair(lp._item(value.first, typename _Expr::Key()), 
   644                                value.second);
   645         return *this;
   646       }
   647 
   648       MappedOutputIterator& operator++() {
   649         ++base;
   650         return *this;
   651       }
   652 
   653       MappedOutputIterator operator++(int) {
   654         MappedOutputIterator tmp(*this);
   655         ++base;
   656         return tmp;
   657       }
   658 
   659       bool operator==(const MappedOutputIterator& it) const {
   660         return base == it.base;
   661       }
   662 
   663       bool operator!=(const MappedOutputIterator& it) const {
   664         return base != it.base;
   665       }
   666 
   667     private:
   668       Base base;
   669       const LpSolverBase& lp;
   670     };
   671 
   672     template <typename Expr>
   673     class MappedInputIterator {
   674     public:
   675 
   676       typedef typename Expr::const_iterator Base;
   677 
   678       typedef typename Base::iterator_category iterator_category;
   679       typedef typename Base::difference_type difference_type;
   680       typedef const std::pair<int, Value> value_type;
   681       typedef value_type reference;
   682       class pointer {
   683       public:
   684         pointer(value_type& _value) : value(_value) {}
   685         value_type* operator->() { return &value; }
   686       private:
   687         value_type value;
   688       };
   689 
   690       MappedInputIterator(const Base& _base, const LpSolverBase& _lp) 
   691         : base(_base), lp(_lp) {}
   692 
   693       reference operator*() {
   694         return std::make_pair(lp._lpId(base->first), base->second);
   695       }
   696 
   697       pointer operator->() {
   698         return pointer(operator*());
   699       }
   700 
   701       MappedInputIterator& operator++() {
   702         ++base;
   703         return *this;
   704       }
   705 
   706       MappedInputIterator operator++(int) {
   707         MappedInputIterator tmp(*this);
   708         ++base;
   709         return tmp;
   710       }
   711 
   712       bool operator==(const MappedInputIterator& it) const {
   713         return base == it.base;
   714       }
   715 
   716       bool operator!=(const MappedInputIterator& it) const {
   717         return base != it.base;
   718       }
   719 
   720     private:
   721       Base base;
   722       const LpSolverBase& lp;
   723     };
   724 
   725   protected:
   726 
   727     /// STL compatible iterator for lp col
   728     typedef MappedInputIterator<Expr> ConstRowIterator;
   729     /// STL compatible iterator for lp row
   730     typedef MappedInputIterator<DualExpr> ConstColIterator;
   731 
   732     /// STL compatible iterator for lp col
   733     typedef MappedOutputIterator<Expr> RowIterator;
   734     /// STL compatible iterator for lp row
   735     typedef MappedOutputIterator<DualExpr> ColIterator;
   736 
   737     //Abstract virtual functions
   738     virtual LpSolverBase &_newLp() = 0;
   739     virtual LpSolverBase &_copyLp(){
   740       ///\todo This should be implemented here, too, when we have
   741       ///problem retrieving routines. It can be overriden.
   742 
   743       //Starting:
   744       LpSolverBase & newlp(_newLp());
   745       return newlp;
   746       //return *(LpSolverBase*)0;
   747     };
   748 
   749     virtual int _addCol() = 0;
   750     virtual int _addRow() = 0; 
   751 
   752     virtual void _eraseCol(int col) = 0;
   753     virtual void _eraseRow(int row) = 0;
   754 
   755     virtual void _getColName(int col, std::string & name) const = 0;
   756     virtual void _setColName(int col, const std::string & name) = 0;
   757     virtual int _colByName(const std::string& name) const = 0;
   758 
   759     virtual void _setRowCoeffs(int i, ConstRowIterator b, 
   760                                ConstRowIterator e) = 0;
   761     virtual void _getRowCoeffs(int i, RowIterator b) const = 0;
   762     virtual void _setColCoeffs(int i, ConstColIterator b, 
   763                                ConstColIterator e) = 0;
   764     virtual void _getColCoeffs(int i, ColIterator b) const = 0;
   765     virtual void _setCoeff(int row, int col, Value value) = 0;
   766     virtual Value _getCoeff(int row, int col) const = 0;
   767     virtual void _setColLowerBound(int i, Value value) = 0;
   768     virtual Value _getColLowerBound(int i) const = 0;
   769     virtual void _setColUpperBound(int i, Value value) = 0;
   770     virtual Value _getColUpperBound(int i) const = 0;
   771     virtual void _setRowBounds(int i, Value lower, Value upper) = 0;
   772     virtual void _getRowBounds(int i, Value &lower, Value &upper) const = 0;
   773 
   774     virtual void _setObjCoeff(int i, Value obj_coef) = 0;
   775     virtual Value _getObjCoeff(int i) const = 0;
   776     virtual void _clearObj()=0;
   777 
   778     virtual SolveExitStatus _solve() = 0;
   779     virtual Value _getPrimal(int i) const = 0;
   780     virtual Value _getDual(int i) const = 0;
   781     virtual Value _getPrimalValue() const = 0;
   782     virtual bool _isBasicCol(int i) const = 0;
   783     virtual SolutionStatus _getPrimalStatus() const = 0;
   784     virtual SolutionStatus _getDualStatus() const = 0;
   785     virtual ProblemTypes _getProblemType() const = 0;
   786 
   787     virtual void _setMax() = 0;
   788     virtual void _setMin() = 0;
   789     
   790 
   791     virtual bool _isMax() const = 0;
   792 
   793     //Own protected stuff
   794     
   795     //Constant component of the objective function
   796     Value obj_const_comp;
   797         
   798   public:
   799 
   800     ///\e
   801     LpSolverBase() : obj_const_comp(0) {}
   802 
   803     ///\e
   804     virtual ~LpSolverBase() {}
   805 
   806     ///Creates a new LP problem
   807     LpSolverBase &newLp() {return _newLp();}
   808     ///Makes a copy of the LP problem
   809     LpSolverBase &copyLp() {return _copyLp();}
   810     
   811     ///\name Build up and modify the LP
   812 
   813     ///@{
   814 
   815     ///Add a new empty column (i.e a new variable) to the LP
   816     Col addCol() { Col c; _addCol(); c.id = cols.addId(); return c;}
   817 
   818     ///\brief Adds several new columns
   819     ///(i.e a variables) at once
   820     ///
   821     ///This magic function takes a container as its argument
   822     ///and fills its elements
   823     ///with new columns (i.e. variables)
   824     ///\param t can be
   825     ///- a standard STL compatible iterable container with
   826     ///\ref Col as its \c values_type
   827     ///like
   828     ///\code
   829     ///std::vector<LpSolverBase::Col>
   830     ///std::list<LpSolverBase::Col>
   831     ///\endcode
   832     ///- a standard STL compatible iterable container with
   833     ///\ref Col as its \c mapped_type
   834     ///like
   835     ///\code
   836     ///std::map<AnyType,LpSolverBase::Col>
   837     ///\endcode
   838     ///- an iterable lemon \ref concepts::WriteMap "write map" like 
   839     ///\code
   840     ///ListGraph::NodeMap<LpSolverBase::Col>
   841     ///ListGraph::EdgeMap<LpSolverBase::Col>
   842     ///\endcode
   843     ///\return The number of the created column.
   844 #ifdef DOXYGEN
   845     template<class T>
   846     int addColSet(T &t) { return 0;} 
   847 #else
   848     template<class T>
   849     typename enable_if<typename T::value_type::LpSolverCol,int>::type
   850     addColSet(T &t,dummy<0> = 0) {
   851       int s=0;
   852       for(typename T::iterator i=t.begin();i!=t.end();++i) {*i=addCol();s++;}
   853       return s;
   854     }
   855     template<class T>
   856     typename enable_if<typename T::value_type::second_type::LpSolverCol,
   857 		       int>::type
   858     addColSet(T &t,dummy<1> = 1) { 
   859       int s=0;
   860       for(typename T::iterator i=t.begin();i!=t.end();++i) {
   861 	i->second=addCol();
   862 	s++;
   863       }
   864       return s;
   865     }
   866     template<class T>
   867     typename enable_if<typename T::MapIt::Value::LpSolverCol,
   868 		       int>::type
   869     addColSet(T &t,dummy<2> = 2) { 
   870       int s=0;
   871       for(typename T::MapIt i(t); i!=INVALID; ++i)
   872 	{
   873 	  i.set(addCol());
   874 	  s++;
   875 	}
   876       return s;
   877     }
   878 #endif
   879 
   880     ///Set a column (i.e a dual constraint) of the LP
   881 
   882     ///\param c is the column to be modified
   883     ///\param e is a dual linear expression (see \ref DualExpr)
   884     ///a better one.
   885     void col(Col c,const DualExpr &e) {
   886       e.simplify();
   887       _setColCoeffs(_lpId(c), ConstColIterator(e.begin(), *this), 
   888                     ConstColIterator(e.end(), *this));
   889     }
   890 
   891     ///Get a column (i.e a dual constraint) of the LP
   892 
   893     ///\param r is the column to get
   894     ///\return the dual expression associated to the column
   895     DualExpr col(Col c) const {
   896       DualExpr e;
   897       _getColCoeffs(_lpId(c), ColIterator(std::inserter(e, e.end()), *this));
   898       return e;
   899     }
   900 
   901     ///Add a new column to the LP
   902 
   903     ///\param e is a dual linear expression (see \ref DualExpr)
   904     ///\param obj is the corresponding component of the objective
   905     ///function. It is 0 by default.
   906     ///\return The created column.
   907     Col addCol(const DualExpr &e, Value o = 0) {
   908       Col c=addCol();
   909       col(c,e);
   910       objCoeff(c,o);
   911       return c;
   912     }
   913 
   914     ///Add a new empty row (i.e a new constraint) to the LP
   915 
   916     ///This function adds a new empty row (i.e a new constraint) to the LP.
   917     ///\return The created row
   918     Row addRow() { Row r; _addRow(); r.id = rows.addId(); return r;}
   919 
   920     ///\brief Add several new rows
   921     ///(i.e a constraints) at once
   922     ///
   923     ///This magic function takes a container as its argument
   924     ///and fills its elements
   925     ///with new row (i.e. variables)
   926     ///\param t can be
   927     ///- a standard STL compatible iterable container with
   928     ///\ref Row as its \c values_type
   929     ///like
   930     ///\code
   931     ///std::vector<LpSolverBase::Row>
   932     ///std::list<LpSolverBase::Row>
   933     ///\endcode
   934     ///- a standard STL compatible iterable container with
   935     ///\ref Row as its \c mapped_type
   936     ///like
   937     ///\code
   938     ///std::map<AnyType,LpSolverBase::Row>
   939     ///\endcode
   940     ///- an iterable lemon \ref concepts::WriteMap "write map" like 
   941     ///\code
   942     ///ListGraph::NodeMap<LpSolverBase::Row>
   943     ///ListGraph::EdgeMap<LpSolverBase::Row>
   944     ///\endcode
   945     ///\return The number of rows created.
   946 #ifdef DOXYGEN
   947     template<class T>
   948     int addRowSet(T &t) { return 0;} 
   949 #else
   950     template<class T>
   951     typename enable_if<typename T::value_type::LpSolverRow,int>::type
   952     addRowSet(T &t,dummy<0> = 0) {
   953       int s=0;
   954       for(typename T::iterator i=t.begin();i!=t.end();++i) {*i=addRow();s++;}
   955       return s;
   956     }
   957     template<class T>
   958     typename enable_if<typename T::value_type::second_type::LpSolverRow,
   959 		       int>::type
   960     addRowSet(T &t,dummy<1> = 1) { 
   961       int s=0;
   962       for(typename T::iterator i=t.begin();i!=t.end();++i) {
   963 	i->second=addRow();
   964 	s++;
   965       }
   966       return s;
   967     }
   968     template<class T>
   969     typename enable_if<typename T::MapIt::Value::LpSolverRow,
   970 		       int>::type
   971     addRowSet(T &t,dummy<2> = 2) { 
   972       int s=0;
   973       for(typename T::MapIt i(t); i!=INVALID; ++i)
   974 	{
   975 	  i.set(addRow());
   976 	  s++;
   977 	}
   978       return s;
   979     }
   980 #endif
   981 
   982     ///Set a row (i.e a constraint) of the LP
   983 
   984     ///\param r is the row to be modified
   985     ///\param l is lower bound (-\ref INF means no bound)
   986     ///\param e is a linear expression (see \ref Expr)
   987     ///\param u is the upper bound (\ref INF means no bound)
   988     ///\bug This is a temporary function. The interface will change to
   989     ///a better one.
   990     ///\todo Option to control whether a constraint with a single variable is
   991     ///added or not.
   992     void row(Row r, Value l, const Expr &e, Value u) {
   993       e.simplify();
   994       _setRowCoeffs(_lpId(r), ConstRowIterator(e.begin(), *this),
   995                     ConstRowIterator(e.end(), *this));
   996       _setRowBounds(_lpId(r),l-e.constComp(),u-e.constComp());
   997     }
   998 
   999     ///Set a row (i.e a constraint) of the LP
  1000 
  1001     ///\param r is the row to be modified
  1002     ///\param c is a linear expression (see \ref Constr)
  1003     void row(Row r, const Constr &c) {
  1004       row(r, c.lowerBounded()?c.lowerBound():-INF,
  1005           c.expr(), c.upperBounded()?c.upperBound():INF);
  1006     }
  1007 
  1008     
  1009     ///Get a row (i.e a constraint) of the LP
  1010 
  1011     ///\param r is the row to get
  1012     ///\return the expression associated to the row
  1013     Expr row(Row r) const {
  1014       Expr e;
  1015       _getRowCoeffs(_lpId(r), RowIterator(std::inserter(e, e.end()), *this));
  1016       return e;
  1017     }
  1018 
  1019     ///Add a new row (i.e a new constraint) to the LP
  1020 
  1021     ///\param l is the lower bound (-\ref INF means no bound)
  1022     ///\param e is a linear expression (see \ref Expr)
  1023     ///\param u is the upper bound (\ref INF means no bound)
  1024     ///\return The created row.
  1025     ///\bug This is a temporary function. The interface will change to
  1026     ///a better one.
  1027     Row addRow(Value l,const Expr &e, Value u) {
  1028       Row r=addRow();
  1029       row(r,l,e,u);
  1030       return r;
  1031     }
  1032 
  1033     ///Add a new row (i.e a new constraint) to the LP
  1034 
  1035     ///\param c is a linear expression (see \ref Constr)
  1036     ///\return The created row.
  1037     Row addRow(const Constr &c) {
  1038       Row r=addRow();
  1039       row(r,c);
  1040       return r;
  1041     }
  1042     ///Erase a coloumn (i.e a variable) from the LP
  1043 
  1044     ///\param c is the coloumn to be deleted
  1045     ///\todo Please check this
  1046     void eraseCol(Col c) {
  1047       _eraseCol(_lpId(c));
  1048       cols.eraseId(c.id);
  1049     }
  1050     ///Erase a  row (i.e a constraint) from the LP
  1051 
  1052     ///\param r is the row to be deleted
  1053     ///\todo Please check this
  1054     void eraseRow(Row r) {
  1055       _eraseRow(_lpId(r));
  1056       rows.eraseId(r.id);
  1057     }
  1058 
  1059     /// Get the name of a column
  1060     
  1061     ///\param c is the coresponding coloumn 
  1062     ///\return The name of the colunm
  1063     std::string colName(Col c) const {
  1064       std::string name;
  1065       _getColName(_lpId(c), name);
  1066       return name;
  1067     }
  1068     
  1069     /// Set the name of a column
  1070     
  1071     ///\param c is the coresponding coloumn 
  1072     ///\param name The name to be given
  1073     void colName(Col c, const std::string& name) {
  1074       _setColName(_lpId(c), name);
  1075     }
  1076 
  1077     /// Get the column by its name
  1078     
  1079     ///\param name The name of the column
  1080     ///\return the proper column or \c INVALID
  1081     Col colByName(const std::string& name) const {
  1082       int k = _colByName(name);
  1083       return k != -1 ? Col(cols.fixId(k)) : Col(INVALID);
  1084     }
  1085     
  1086     /// Set an element of the coefficient matrix of the LP
  1087 
  1088     ///\param r is the row of the element to be modified
  1089     ///\param c is the coloumn of the element to be modified
  1090     ///\param val is the new value of the coefficient
  1091 
  1092     void coeff(Row r, Col c, Value val) {
  1093       _setCoeff(_lpId(r),_lpId(c), val);
  1094     }
  1095 
  1096     /// Get an element of the coefficient matrix of the LP
  1097 
  1098     ///\param r is the row of the element in question
  1099     ///\param c is the coloumn of the element in question
  1100     ///\return the corresponding coefficient
  1101 
  1102     Value coeff(Row r, Col c) const {
  1103       return _getCoeff(_lpId(r),_lpId(c));
  1104     }
  1105 
  1106     /// Set the lower bound of a column (i.e a variable)
  1107 
  1108     /// The lower bound of a variable (column) has to be given by an 
  1109     /// extended number of type Value, i.e. a finite number of type 
  1110     /// Value or -\ref INF.
  1111     void colLowerBound(Col c, Value value) {
  1112       _setColLowerBound(_lpId(c),value);
  1113     }
  1114 
  1115     /// Get the lower bound of a column (i.e a variable)
  1116 
  1117     /// This function returns the lower bound for column (variable) \t c
  1118     /// (this might be -\ref INF as well).  
  1119     ///\return The lower bound for coloumn \t c
  1120     Value colLowerBound(Col c) const {
  1121       return _getColLowerBound(_lpId(c));
  1122     }
  1123     
  1124     ///\brief Set the lower bound of  several columns
  1125     ///(i.e a variables) at once
  1126     ///
  1127     ///This magic function takes a container as its argument
  1128     ///and applies the function on all of its elements.
  1129     /// The lower bound of a variable (column) has to be given by an 
  1130     /// extended number of type Value, i.e. a finite number of type 
  1131     /// Value or -\ref INF.
  1132 #ifdef DOXYGEN
  1133     template<class T>
  1134     void colLowerBound(T &t, Value value) { return 0;} 
  1135 #else
  1136     template<class T>
  1137     typename enable_if<typename T::value_type::LpSolverCol,void>::type
  1138     colLowerBound(T &t, Value value,dummy<0> = 0) {
  1139       for(typename T::iterator i=t.begin();i!=t.end();++i) {
  1140 	colLowerBound(*i, value);
  1141       }
  1142     }
  1143     template<class T>
  1144     typename enable_if<typename T::value_type::second_type::LpSolverCol,
  1145 		       void>::type
  1146     colLowerBound(T &t, Value value,dummy<1> = 1) { 
  1147       for(typename T::iterator i=t.begin();i!=t.end();++i) {
  1148 	colLowerBound(i->second, value);
  1149       }
  1150     }
  1151     template<class T>
  1152     typename enable_if<typename T::MapIt::Value::LpSolverCol,
  1153 		       void>::type
  1154     colLowerBound(T &t, Value value,dummy<2> = 2) { 
  1155       for(typename T::MapIt i(t); i!=INVALID; ++i){
  1156 	colLowerBound(*i, value);
  1157       }
  1158     }
  1159 #endif
  1160     
  1161     /// Set the upper bound of a column (i.e a variable)
  1162 
  1163     /// The upper bound of a variable (column) has to be given by an 
  1164     /// extended number of type Value, i.e. a finite number of type 
  1165     /// Value or \ref INF.
  1166     void colUpperBound(Col c, Value value) {
  1167       _setColUpperBound(_lpId(c),value);
  1168     };
  1169 
  1170     /// Get the upper bound of a column (i.e a variable)
  1171 
  1172     /// This function returns the upper bound for column (variable) \t c
  1173     /// (this might be \ref INF as well).  
  1174     ///\return The upper bound for coloumn \t c
  1175     Value colUpperBound(Col c) const {
  1176       return _getColUpperBound(_lpId(c));
  1177     }
  1178 
  1179     ///\brief Set the upper bound of  several columns
  1180     ///(i.e a variables) at once
  1181     ///
  1182     ///This magic function takes a container as its argument
  1183     ///and applies the function on all of its elements.
  1184     /// The upper bound of a variable (column) has to be given by an 
  1185     /// extended number of type Value, i.e. a finite number of type 
  1186     /// Value or \ref INF.
  1187 #ifdef DOXYGEN
  1188     template<class T>
  1189     void colUpperBound(T &t, Value value) { return 0;} 
  1190 #else
  1191     template<class T>
  1192     typename enable_if<typename T::value_type::LpSolverCol,void>::type
  1193     colUpperBound(T &t, Value value,dummy<0> = 0) {
  1194       for(typename T::iterator i=t.begin();i!=t.end();++i) {
  1195 	colUpperBound(*i, value);
  1196       }
  1197     }
  1198     template<class T>
  1199     typename enable_if<typename T::value_type::second_type::LpSolverCol,
  1200 		       void>::type
  1201     colUpperBound(T &t, Value value,dummy<1> = 1) { 
  1202       for(typename T::iterator i=t.begin();i!=t.end();++i) {
  1203 	colUpperBound(i->second, value);
  1204       }
  1205     }
  1206     template<class T>
  1207     typename enable_if<typename T::MapIt::Value::LpSolverCol,
  1208 		       void>::type
  1209     colUpperBound(T &t, Value value,dummy<2> = 2) { 
  1210       for(typename T::MapIt i(t); i!=INVALID; ++i){
  1211 	colUpperBound(*i, value);
  1212       }
  1213     }
  1214 #endif
  1215 
  1216     /// Set the lower and the upper bounds of a column (i.e a variable)
  1217 
  1218     /// The lower and the upper bounds of
  1219     /// a variable (column) have to be given by an 
  1220     /// extended number of type Value, i.e. a finite number of type 
  1221     /// Value, -\ref INF or \ref INF.
  1222     void colBounds(Col c, Value lower, Value upper) {
  1223       _setColLowerBound(_lpId(c),lower);
  1224       _setColUpperBound(_lpId(c),upper);
  1225     }
  1226     
  1227     ///\brief Set the lower and the upper bound of several columns
  1228     ///(i.e a variables) at once
  1229     ///
  1230     ///This magic function takes a container as its argument
  1231     ///and applies the function on all of its elements.
  1232     /// The lower and the upper bounds of
  1233     /// a variable (column) have to be given by an 
  1234     /// extended number of type Value, i.e. a finite number of type 
  1235     /// Value, -\ref INF or \ref INF.
  1236 #ifdef DOXYGEN
  1237     template<class T>
  1238     void colBounds(T &t, Value lower, Value upper) { return 0;} 
  1239 #else
  1240     template<class T>
  1241     typename enable_if<typename T::value_type::LpSolverCol,void>::type
  1242     colBounds(T &t, Value lower, Value upper,dummy<0> = 0) {
  1243       for(typename T::iterator i=t.begin();i!=t.end();++i) {
  1244 	colBounds(*i, lower, upper);
  1245       }
  1246     }
  1247     template<class T>
  1248     typename enable_if<typename T::value_type::second_type::LpSolverCol,
  1249 		       void>::type
  1250     colBounds(T &t, Value lower, Value upper,dummy<1> = 1) { 
  1251       for(typename T::iterator i=t.begin();i!=t.end();++i) {
  1252 	colBounds(i->second, lower, upper);
  1253       }
  1254     }
  1255     template<class T>
  1256     typename enable_if<typename T::MapIt::Value::LpSolverCol,
  1257 		       void>::type
  1258     colBounds(T &t, Value lower, Value upper,dummy<2> = 2) { 
  1259       for(typename T::MapIt i(t); i!=INVALID; ++i){
  1260 	colBounds(*i, lower, upper);
  1261       }
  1262     }
  1263 #endif
  1264     
  1265 
  1266     /// Set the lower and the upper bounds of a row (i.e a constraint)
  1267 
  1268     /// The lower and the upper bound of a constraint (row) have to be
  1269     /// given by an extended number of type Value, i.e. a finite
  1270     /// number of type Value, -\ref INF or \ref INF. There is no
  1271     /// separate function for the lower and the upper bound because
  1272     /// that would have been hard to implement for CPLEX.
  1273     void rowBounds(Row c, Value lower, Value upper) {
  1274       _setRowBounds(_lpId(c),lower, upper);
  1275     }
  1276     
  1277     /// Get the lower and the upper bounds of a row (i.e a constraint)
  1278 
  1279     /// The lower and the upper bound of
  1280     /// a constraint (row) are  
  1281     /// extended numbers of type Value, i.e.  finite numbers of type 
  1282     /// Value, -\ref INF or \ref INF. 
  1283     /// \todo There is no separate function for the 
  1284     /// lower and the upper bound because we had problems with the 
  1285     /// implementation of the setting functions for CPLEX:  
  1286     /// check out whether this can be done for these functions.
  1287     void getRowBounds(Row c, Value &lower, Value &upper) const {
  1288       _getRowBounds(_lpId(c),lower, upper);
  1289     }
  1290 
  1291     ///Set an element of the objective function
  1292     void objCoeff(Col c, Value v) {_setObjCoeff(_lpId(c),v); };
  1293 
  1294     ///Get an element of the objective function
  1295     Value objCoeff(Col c) const { return _getObjCoeff(_lpId(c)); };
  1296 
  1297     ///Set the objective function
  1298 
  1299     ///\param e is a linear expression of type \ref Expr.
  1300     void obj(Expr e) {
  1301       _clearObj();
  1302       for (Expr::iterator i=e.begin(); i!=e.end(); ++i)
  1303 	objCoeff((*i).first,(*i).second);
  1304       obj_const_comp=e.constComp();
  1305     }
  1306 
  1307     ///Get the objective function
  1308 
  1309     ///\return the objective function as a linear expression of type \ref Expr.
  1310     Expr obj() const {
  1311       Expr e;
  1312       for (ColIt it(*this); it != INVALID; ++it) {
  1313         double c = objCoeff(it);
  1314         if (c != 0.0) {
  1315           e.insert(std::make_pair(it, c));
  1316         }
  1317       }
  1318       return e;
  1319     }
  1320     
  1321 
  1322     ///Maximize
  1323     void max() { _setMax(); }
  1324     ///Minimize
  1325     void min() { _setMin(); }
  1326 
  1327     ///Query function: is this a maximization problem?
  1328     bool isMax() const {return _isMax(); }
  1329 
  1330     ///Query function: is this a minimization problem?
  1331     bool isMin() const {return !isMax(); }
  1332     
  1333     ///@}
  1334 
  1335 
  1336     ///\name Solve the LP
  1337 
  1338     ///@{
  1339 
  1340     ///\e Solve the LP problem at hand
  1341     ///
  1342     ///\return The result of the optimization procedure. Possible 
  1343     ///values and their meanings can be found in the documentation of 
  1344     ///\ref SolveExitStatus.
  1345     ///
  1346     ///\todo Which method is used to solve the problem
  1347     SolveExitStatus solve() { return _solve(); }
  1348     
  1349     ///@}
  1350     
  1351     ///\name Obtain the solution
  1352 
  1353     ///@{
  1354 
  1355     /// The status of the primal problem (the original LP problem)
  1356     SolutionStatus primalStatus() const {
  1357       return _getPrimalStatus();
  1358     }
  1359 
  1360     /// The status of the dual (of the original LP) problem 
  1361     SolutionStatus dualStatus() const {
  1362       return _getDualStatus();
  1363     }
  1364 
  1365     ///The type of the original LP problem
  1366     ProblemTypes problemType() const {
  1367       return _getProblemType();
  1368     }
  1369 
  1370     ///\e
  1371     Value primal(Col c) const { return _getPrimal(_lpId(c)); }
  1372     ///\e
  1373     Value primal(const Expr& e) const {
  1374       double res = e.constComp();
  1375       for (std::map<Col, double>::const_iterator it = e.begin();
  1376 	   it != e.end(); ++it) {
  1377 	res += _getPrimal(_lpId(it->first)) * it->second;
  1378       }
  1379       return res; 
  1380     }
  1381 
  1382     ///\e
  1383     Value dual(Row r) const { return _getDual(_lpId(r)); }
  1384     ///\e
  1385     Value dual(const DualExpr& e) const {
  1386       double res = 0.0;
  1387       for (std::map<Row, double>::const_iterator it = e.begin();
  1388 	   it != e.end(); ++it) {
  1389 	res += _getPrimal(_lpId(it->first)) * it->second;
  1390       }
  1391       return res; 
  1392     }
  1393 
  1394     ///\e
  1395     bool isBasicCol(Col c) const { return _isBasicCol(_lpId(c)); }
  1396 
  1397     ///\e
  1398 
  1399     ///\return
  1400     ///- \ref INF or -\ref INF means either infeasibility or unboundedness
  1401     /// of the primal problem, depending on whether we minimize or maximize.
  1402     ///- \ref NaN if no primal solution is found.
  1403     ///- The (finite) objective value if an optimal solution is found.
  1404     Value primalValue() const { return _getPrimalValue()+obj_const_comp;}
  1405     ///@}
  1406     
  1407   };  
  1408 
  1409 
  1410   /// \ingroup lp_group
  1411   ///
  1412   /// \brief Common base class for MIP solvers
  1413   /// \todo Much more docs
  1414   class MipSolverBase : virtual public LpSolverBase{
  1415   public:
  1416 
  1417     ///Possible variable (coloumn) types (e.g. real, integer, binary etc.)
  1418     enum ColTypes {
  1419       ///Continuous variable
  1420       REAL = 0,
  1421       ///Integer variable
  1422 
  1423       ///Unfortunately, cplex 7.5 somewhere writes something like
  1424       ///#define INTEGER 'I'
  1425       INT = 1
  1426       ///\todo No support for other types yet.
  1427     };
  1428 
  1429     ///Sets the type of the given coloumn to the given type
  1430     ///
  1431     ///Sets the type of the given coloumn to the given type.
  1432     void colType(Col c, ColTypes col_type) {
  1433       _colType(_lpId(c),col_type);
  1434     }
  1435 
  1436     ///Gives back the type of the column.
  1437     ///
  1438     ///Gives back the type of the column.
  1439     ColTypes colType(Col c) const {
  1440       return _colType(_lpId(c));
  1441     }
  1442 
  1443     ///Sets the type of the given Col to integer or remove that property.
  1444     ///
  1445     ///Sets the type of the given Col to integer or remove that property.
  1446     void integer(Col c, bool enable) {
  1447       if (enable)
  1448 	colType(c,INT);
  1449       else
  1450 	colType(c,REAL);
  1451     }
  1452 
  1453     ///Gives back whether the type of the column is integer or not.
  1454     ///
  1455     ///Gives back the type of the column.
  1456     ///\return true if the column has integer type and false if not.
  1457     bool integer(Col c) const {
  1458       return (colType(c)==INT);
  1459     }
  1460 
  1461     /// The status of the MIP problem
  1462     SolutionStatus mipStatus() const {
  1463       return _getMipStatus();
  1464     }
  1465 
  1466   protected:
  1467 
  1468     virtual ColTypes _colType(int col) const = 0;
  1469     virtual void _colType(int col, ColTypes col_type) = 0;
  1470     virtual SolutionStatus _getMipStatus() const = 0;
  1471 
  1472   };
  1473   
  1474   ///\relates LpSolverBase::Expr
  1475   ///
  1476   inline LpSolverBase::Expr operator+(const LpSolverBase::Expr &a,
  1477 				      const LpSolverBase::Expr &b) 
  1478   {
  1479     LpSolverBase::Expr tmp(a);
  1480     tmp+=b;
  1481     return tmp;
  1482   }
  1483   ///\e
  1484   
  1485   ///\relates LpSolverBase::Expr
  1486   ///
  1487   inline LpSolverBase::Expr operator-(const LpSolverBase::Expr &a,
  1488 				      const LpSolverBase::Expr &b) 
  1489   {
  1490     LpSolverBase::Expr tmp(a);
  1491     tmp-=b;
  1492     return tmp;
  1493   }
  1494   ///\e
  1495   
  1496   ///\relates LpSolverBase::Expr
  1497   ///
  1498   inline LpSolverBase::Expr operator*(const LpSolverBase::Expr &a,
  1499 				      const LpSolverBase::Value &b) 
  1500   {
  1501     LpSolverBase::Expr tmp(a);
  1502     tmp*=b;
  1503     return tmp;
  1504   }
  1505   
  1506   ///\e
  1507   
  1508   ///\relates LpSolverBase::Expr
  1509   ///
  1510   inline LpSolverBase::Expr operator*(const LpSolverBase::Value &a,
  1511 				      const LpSolverBase::Expr &b) 
  1512   {
  1513     LpSolverBase::Expr tmp(b);
  1514     tmp*=a;
  1515     return tmp;
  1516   }
  1517   ///\e
  1518   
  1519   ///\relates LpSolverBase::Expr
  1520   ///
  1521   inline LpSolverBase::Expr operator/(const LpSolverBase::Expr &a,
  1522 				      const LpSolverBase::Value &b) 
  1523   {
  1524     LpSolverBase::Expr tmp(a);
  1525     tmp/=b;
  1526     return tmp;
  1527   }
  1528   
  1529   ///\e
  1530   
  1531   ///\relates LpSolverBase::Constr
  1532   ///
  1533   inline LpSolverBase::Constr operator<=(const LpSolverBase::Expr &e,
  1534 					 const LpSolverBase::Expr &f) 
  1535   {
  1536     return LpSolverBase::Constr(-LpSolverBase::INF,e-f,0);
  1537   }
  1538 
  1539   ///\e
  1540   
  1541   ///\relates LpSolverBase::Constr
  1542   ///
  1543   inline LpSolverBase::Constr operator<=(const LpSolverBase::Value &e,
  1544 					 const LpSolverBase::Expr &f) 
  1545   {
  1546     return LpSolverBase::Constr(e,f);
  1547   }
  1548 
  1549   ///\e
  1550   
  1551   ///\relates LpSolverBase::Constr
  1552   ///
  1553   inline LpSolverBase::Constr operator<=(const LpSolverBase::Expr &e,
  1554 					 const LpSolverBase::Value &f) 
  1555   {
  1556     return LpSolverBase::Constr(e,f);
  1557   }
  1558 
  1559   ///\e
  1560   
  1561   ///\relates LpSolverBase::Constr
  1562   ///
  1563   inline LpSolverBase::Constr operator>=(const LpSolverBase::Expr &e,
  1564 					 const LpSolverBase::Expr &f) 
  1565   {
  1566     return LpSolverBase::Constr(-LpSolverBase::INF,f-e,0);
  1567   }
  1568 
  1569 
  1570   ///\e
  1571   
  1572   ///\relates LpSolverBase::Constr
  1573   ///
  1574   inline LpSolverBase::Constr operator>=(const LpSolverBase::Value &e,
  1575 					 const LpSolverBase::Expr &f) 
  1576   {
  1577     return LpSolverBase::Constr(f,e);
  1578   }
  1579 
  1580 
  1581   ///\e
  1582   
  1583   ///\relates LpSolverBase::Constr
  1584   ///
  1585   inline LpSolverBase::Constr operator>=(const LpSolverBase::Expr &e,
  1586 					 const LpSolverBase::Value &f) 
  1587   {
  1588     return LpSolverBase::Constr(f,e);
  1589   }
  1590 
  1591   ///\e
  1592 
  1593   ///\relates LpSolverBase::Constr
  1594   ///
  1595   inline LpSolverBase::Constr operator==(const LpSolverBase::Expr &e,
  1596 					 const LpSolverBase::Value &f) 
  1597   {
  1598     return LpSolverBase::Constr(f,e,f);
  1599   }
  1600 
  1601   ///\e
  1602   
  1603   ///\relates LpSolverBase::Constr
  1604   ///
  1605   inline LpSolverBase::Constr operator==(const LpSolverBase::Expr &e,
  1606 					 const LpSolverBase::Expr &f) 
  1607   {
  1608     return LpSolverBase::Constr(0,e-f,0);
  1609   }
  1610 
  1611   ///\e
  1612   
  1613   ///\relates LpSolverBase::Constr
  1614   ///
  1615   inline LpSolverBase::Constr operator<=(const LpSolverBase::Value &n,
  1616 					 const LpSolverBase::Constr&c) 
  1617   {
  1618     LpSolverBase::Constr tmp(c);
  1619     ///\todo Create an own exception type.
  1620     if(!LpSolverBase::isNaN(tmp.lowerBound())) throw LogicError();
  1621     else tmp.lowerBound()=n;
  1622     return tmp;
  1623   }
  1624   ///\e
  1625   
  1626   ///\relates LpSolverBase::Constr
  1627   ///
  1628   inline LpSolverBase::Constr operator<=(const LpSolverBase::Constr& c,
  1629 					 const LpSolverBase::Value &n)
  1630   {
  1631     LpSolverBase::Constr tmp(c);
  1632     ///\todo Create an own exception type.
  1633     if(!LpSolverBase::isNaN(tmp.upperBound())) throw LogicError();
  1634     else tmp.upperBound()=n;
  1635     return tmp;
  1636   }
  1637 
  1638   ///\e
  1639   
  1640   ///\relates LpSolverBase::Constr
  1641   ///
  1642   inline LpSolverBase::Constr operator>=(const LpSolverBase::Value &n,
  1643 					 const LpSolverBase::Constr&c) 
  1644   {
  1645     LpSolverBase::Constr tmp(c);
  1646     ///\todo Create an own exception type.
  1647     if(!LpSolverBase::isNaN(tmp.upperBound())) throw LogicError();
  1648     else tmp.upperBound()=n;
  1649     return tmp;
  1650   }
  1651   ///\e
  1652   
  1653   ///\relates LpSolverBase::Constr
  1654   ///
  1655   inline LpSolverBase::Constr operator>=(const LpSolverBase::Constr& c,
  1656 					 const LpSolverBase::Value &n)
  1657   {
  1658     LpSolverBase::Constr tmp(c);
  1659     ///\todo Create an own exception type.
  1660     if(!LpSolverBase::isNaN(tmp.lowerBound())) throw LogicError();
  1661     else tmp.lowerBound()=n;
  1662     return tmp;
  1663   }
  1664 
  1665   ///\e
  1666   
  1667   ///\relates LpSolverBase::DualExpr
  1668   ///
  1669   inline LpSolverBase::DualExpr operator+(const LpSolverBase::DualExpr &a,
  1670                                           const LpSolverBase::DualExpr &b) 
  1671   {
  1672     LpSolverBase::DualExpr tmp(a);
  1673     tmp+=b;
  1674     return tmp;
  1675   }
  1676   ///\e
  1677   
  1678   ///\relates LpSolverBase::DualExpr
  1679   ///
  1680   inline LpSolverBase::DualExpr operator-(const LpSolverBase::DualExpr &a,
  1681                                           const LpSolverBase::DualExpr &b) 
  1682   {
  1683     LpSolverBase::DualExpr tmp(a);
  1684     tmp-=b;
  1685     return tmp;
  1686   }
  1687   ///\e
  1688   
  1689   ///\relates LpSolverBase::DualExpr
  1690   ///
  1691   inline LpSolverBase::DualExpr operator*(const LpSolverBase::DualExpr &a,
  1692                                           const LpSolverBase::Value &b) 
  1693   {
  1694     LpSolverBase::DualExpr tmp(a);
  1695     tmp*=b;
  1696     return tmp;
  1697   }
  1698   
  1699   ///\e
  1700   
  1701   ///\relates LpSolverBase::DualExpr
  1702   ///
  1703   inline LpSolverBase::DualExpr operator*(const LpSolverBase::Value &a,
  1704                                           const LpSolverBase::DualExpr &b) 
  1705   {
  1706     LpSolverBase::DualExpr tmp(b);
  1707     tmp*=a;
  1708     return tmp;
  1709   }
  1710   ///\e
  1711   
  1712   ///\relates LpSolverBase::DualExpr
  1713   ///
  1714   inline LpSolverBase::DualExpr operator/(const LpSolverBase::DualExpr &a,
  1715                                           const LpSolverBase::Value &b) 
  1716   {
  1717     LpSolverBase::DualExpr tmp(a);
  1718     tmp/=b;
  1719     return tmp;
  1720   }
  1721   
  1722 
  1723 } //namespace lemon
  1724 
  1725 #endif //LEMON_LP_BASE_H