lemon/lp_glpk.h
author Balazs Dezso <deba@inf.elte.hu>
Tue, 02 Dec 2008 21:40:33 +0100
changeset 458 7afc121e0689
child 459 ed54c0d13df0
permissions -rw-r--r--
Port LP and MIP solvers from SVN -r3509 (#44)
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library.
     4  *
     5  * Copyright (C) 2003-2008
     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_GLPK_H
    20 #define LEMON_LP_GLPK_H
    21 
    22 ///\file
    23 ///\brief Header of the LEMON-GLPK lp solver interface.
    24 ///\ingroup lp_group
    25 
    26 #include <lemon/lp_base.h>
    27 
    28 // forward declaration
    29 #ifndef _GLP_PROB
    30 #define _GLP_PROB
    31 typedef struct { double _prob; } glp_prob;
    32 /* LP/MIP problem object */
    33 #endif
    34 
    35 namespace lemon {
    36 
    37 
    38   /// \brief Interface for the GLPK LP solver
    39   ///
    40   /// This class implements an interface for the GLPK LP solver.
    41   ///\ingroup lp_group
    42   class LpGlpk : virtual public LpSolverBase {
    43   protected:
    44 
    45     typedef glp_prob LPX;
    46     glp_prob* lp;
    47     bool solved;
    48 
    49   public:
    50 
    51     typedef LpSolverBase Parent;
    52 
    53     LpGlpk();
    54     LpGlpk(const LpGlpk &);
    55     ~LpGlpk();
    56 
    57   protected:
    58     virtual LpSolverBase* _newLp();
    59     virtual LpSolverBase* _copyLp();
    60 
    61     virtual int _addCol();
    62     virtual int _addRow();
    63     virtual void _eraseCol(int i);
    64     virtual void _eraseRow(int i);
    65     virtual void _getColName(int col, std::string & name) const;
    66     virtual void _setColName(int col, const std::string & name);
    67     virtual int _colByName(const std::string& name) const;
    68     virtual void _setRowCoeffs(int i, ConstRowIterator b, ConstRowIterator e);
    69     virtual void _getRowCoeffs(int i, RowIterator b) const;
    70     virtual void _setColCoeffs(int i, ConstColIterator b, ConstColIterator e);
    71     virtual void _getColCoeffs(int i, ColIterator b) const;
    72     virtual void _setCoeff(int row, int col, Value value);
    73     virtual Value _getCoeff(int row, int col) const;
    74 
    75     virtual void _setColLowerBound(int i, Value value);
    76     virtual Value _getColLowerBound(int i) const;
    77     virtual void _setColUpperBound(int i, Value value);
    78     virtual Value _getColUpperBound(int i) const;
    79 
    80     virtual void _setRowBounds(int i, Value lower, Value upper);
    81     virtual void _getRowBounds(int i, Value &lb, Value &ub) const;
    82     virtual void _setObjCoeff(int i, Value obj_coef);
    83     virtual Value _getObjCoeff(int i) const;
    84     virtual void _clearObj();
    85 
    86     ///\e
    87 
    88     ///\todo It should be clarified
    89     ///
    90     virtual SolveExitStatus _solve();
    91     virtual Value _getPrimal(int i) const;
    92     virtual Value _getDual(int i) const;
    93     virtual Value _getPrimalValue() const;
    94     virtual bool _isBasicCol(int i) const;
    95     ///\e
    96 
    97     ///\todo It should be clarified
    98     ///
    99     virtual SolutionStatus _getPrimalStatus() const;
   100     virtual SolutionStatus _getDualStatus() const;
   101     virtual ProblemTypes _getProblemType() const;
   102 
   103     virtual void _setMax();
   104     virtual void _setMin();
   105 
   106     virtual bool _isMax() const;
   107 
   108   public:
   109     ///Set the verbosity of the messages
   110 
   111     ///Set the verbosity of the messages
   112     ///
   113     ///\param m is the level of the messages output by the solver routines.
   114     ///The possible values are:
   115     ///- 0 --- no output (default value)
   116     ///- 1 --- error messages only
   117     ///- 2 --- normal output
   118     ///- 3 --- full output (includes informational messages)
   119     void messageLevel(int m);
   120     ///Turns on or off the presolver
   121 
   122     ///Turns on (\c b is \c true) or off (\c b is \c false) the presolver
   123     ///
   124     ///The presolver is off by default.
   125     void presolver(bool b);
   126 
   127     ///Pointer to the underlying GLPK data structure.
   128     LPX *lpx() {return lp;}
   129 
   130     ///Returns the constraint identifier understood by GLPK.
   131     int lpxRow(Row r) { return _lpId(r); }
   132 
   133     ///Returns the variable identifier understood by GLPK.
   134     int lpxCol(Col c) { return _lpId(c); }
   135   };
   136 } //END OF NAMESPACE LEMON
   137 
   138 #endif //LEMON_LP_GLPK_H
   139