1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
3 * This file is a part of LEMON, a generic C++ optimization library.
5 * Copyright (C) 2003-2008
6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
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.
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
23 ///\brief Header of the LEMON-GLPK lp solver interface.
26 #include <lemon/lp_base.h>
28 // forward declaration
31 typedef struct { double _prob; } glp_prob;
32 /* LP/MIP problem object */
38 /// \brief Base interface for the GLPK LP and MIP solver
40 /// This class implements the common interface of the GLPK LP and MIP solver.
42 class GlpkBase : virtual public LpBase {
49 GlpkBase(const GlpkBase&);
54 virtual int _addCol();
55 virtual int _addRow();
57 virtual void _eraseCol(int i);
58 virtual void _eraseRow(int i);
60 virtual void _eraseColId(int i);
61 virtual void _eraseRowId(int i);
63 virtual void _getColName(int col, std::string& name) const;
64 virtual void _setColName(int col, const std::string& name);
65 virtual int _colByName(const std::string& name) const;
67 virtual void _getRowName(int row, std::string& name) const;
68 virtual void _setRowName(int row, const std::string& name);
69 virtual int _rowByName(const std::string& name) const;
71 virtual void _setRowCoeffs(int i, ExprIterator b, ExprIterator e);
72 virtual void _getRowCoeffs(int i, InsertIterator b) const;
74 virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e);
75 virtual void _getColCoeffs(int i, InsertIterator b) const;
77 virtual void _setCoeff(int row, int col, Value value);
78 virtual Value _getCoeff(int row, int col) const;
80 virtual void _setColLowerBound(int i, Value value);
81 virtual Value _getColLowerBound(int i) const;
83 virtual void _setColUpperBound(int i, Value value);
84 virtual Value _getColUpperBound(int i) const;
86 virtual void _setRowLowerBound(int i, Value value);
87 virtual Value _getRowLowerBound(int i) const;
89 virtual void _setRowUpperBound(int i, Value value);
90 virtual Value _getRowUpperBound(int i) const;
92 virtual void _setObjCoeffs(ExprIterator b, ExprIterator e);
93 virtual void _getObjCoeffs(InsertIterator b) const;
95 virtual void _setObjCoeff(int i, Value obj_coef);
96 virtual Value _getObjCoeff(int i) const;
98 virtual void _setSense(Sense);
99 virtual Sense _getSense() const;
101 virtual void _clear();
105 /// \brief Deallocates the globally allocated memory of GLPK.
107 /// Deallocates the globally allocated memory of GLPK. \note
108 /// Usually, it do not have to be called, because the GLPK use
109 /// only a small amount of global memory, and it is deallocated
110 /// automatically at the end of program.
111 static void freeEnv();
113 ///Pointer to the underlying GLPK data structure.
114 LPX *lpx() {return lp;}
115 ///Const pointer to the underlying GLPK data structure.
116 const LPX *lpx() const {return lp;}
118 ///Returns the constraint identifier understood by GLPK.
119 int lpxRow(Row r) const { return rows(id(r)); }
121 ///Returns the variable identifier understood by GLPK.
122 int lpxCol(Col c) const { return cols(id(c)); }
126 /// \brief Interface for the GLPK LP solver
128 /// This class implements an interface for the GLPK LP solver.
130 class GlpkLp : public GlpkBase, public LpSolver {
136 GlpkLp(const GlpkLp&);
140 mutable std::vector<double> _primal_ray;
141 mutable std::vector<double> _dual_ray;
143 void _clear_temporals();
147 virtual GlpkLp* _cloneSolver() const;
148 virtual GlpkLp* _newSolver() const;
150 virtual const char* _solverName() const;
152 virtual SolveExitStatus _solve();
153 virtual Value _getPrimal(int i) const;
154 virtual Value _getDual(int i) const;
156 virtual Value _getPrimalValue() const;
158 virtual VarStatus _getColStatus(int i) const;
159 virtual VarStatus _getRowStatus(int i) const;
161 virtual Value _getPrimalRay(int i) const;
162 virtual Value _getDualRay(int i) const;
164 ///\todo It should be clarified
166 virtual ProblemType _getPrimalType() const;
167 virtual ProblemType _getDualType() const;
171 ///Solve with primal simplex
172 SolveExitStatus solvePrimal();
174 ///Solve with dual simplex
175 SolveExitStatus solveDual();
177 ///Turns on or off the presolver
179 ///Turns on (\c b is \c true) or off (\c b is \c false) the presolver
181 ///The presolver is off by default.
182 void presolver(bool b);
184 ///Enum for \c messageLevel() parameter
186 /// no output (default value)
187 MESSAGE_NO_OUTPUT = 0,
188 /// error messages only
189 MESSAGE_ERROR_MESSAGE = 1,
191 MESSAGE_NORMAL_OUTPUT = 2,
192 /// full output (includes informational messages)
193 MESSAGE_FULL_OUTPUT = 3
198 MessageLevel _message_level;
202 ///Set the verbosity of the messages
204 ///Set the verbosity of the messages
206 ///\param m is the level of the messages output by the solver routines.
207 void messageLevel(MessageLevel m);
210 /// \brief Interface for the GLPK MIP solver
212 /// This class implements an interface for the GLPK MIP solver.
214 class GlpkMip : public GlpkBase, public MipSolver {
220 GlpkMip(const GlpkMip&);
224 virtual GlpkMip* _cloneSolver() const;
225 virtual GlpkMip* _newSolver() const;
227 virtual const char* _solverName() const;
229 virtual ColTypes _getColType(int col) const;
230 virtual void _setColType(int col, ColTypes col_type);
232 virtual SolveExitStatus _solve();
233 virtual ProblemType _getType() const;
234 virtual Value _getSol(int i) const;
235 virtual Value _getSolValue() const;
237 ///Enum for \c messageLevel() parameter
239 /// no output (default value)
240 MESSAGE_NO_OUTPUT = 0,
241 /// error messages only
242 MESSAGE_ERROR_MESSAGE = 1,
244 MESSAGE_NORMAL_OUTPUT = 2,
245 /// full output (includes informational messages)
246 MESSAGE_FULL_OUTPUT = 3
251 MessageLevel _message_level;
255 ///Set the verbosity of the messages
257 ///Set the verbosity of the messages
259 ///\param m is the level of the messages output by the solver routines.
260 void messageLevel(MessageLevel m);
264 } //END OF NAMESPACE LEMON
266 #endif //LEMON_GLPK_H