COIN-OR::LEMON - Graph Library

source: lemon-main/lemon/glpk.h @ 540:9db62975c32b

Last change on this file since 540:9db62975c32b was 540:9db62975c32b, checked in by Alpar Juttner <alpar@…>, 11 years ago

Fix newSolver()/cloneSolver() API in LP tools + doc improvements (#230)

  • More logical structure for newSolver()/cloneSolver()
  • Fix compilation problem with gcc-3.3
  • Doc improvements
File size: 6.6 KB
Line 
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_GLPK_H
20#define LEMON_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
31typedef struct { double _prob; } glp_prob;
32/* LP/MIP problem object */
33#endif
34
35namespace lemon {
36
37
38  /// \brief Base interface for the GLPK LP and MIP solver
39  ///
40  /// This class implements the common interface of the GLPK LP and MIP solver.
41  /// \ingroup lp_group
42  class GlpkBase : virtual public LpBase {
43  protected:
44
45    typedef glp_prob LPX;
46    glp_prob* lp;
47
48    GlpkBase();
49    GlpkBase(const GlpkBase&);
50    virtual ~GlpkBase();
51
52  protected:
53
54    virtual int _addCol();
55    virtual int _addRow();
56
57    virtual void _eraseCol(int i);
58    virtual void _eraseRow(int i);
59
60    virtual void _eraseColId(int i);
61    virtual void _eraseRowId(int i);
62
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;
66
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;
70
71    virtual void _setRowCoeffs(int i, ExprIterator b, ExprIterator e);
72    virtual void _getRowCoeffs(int i, InsertIterator b) const;
73
74    virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e);
75    virtual void _getColCoeffs(int i, InsertIterator b) const;
76
77    virtual void _setCoeff(int row, int col, Value value);
78    virtual Value _getCoeff(int row, int col) const;
79
80    virtual void _setColLowerBound(int i, Value value);
81    virtual Value _getColLowerBound(int i) const;
82
83    virtual void _setColUpperBound(int i, Value value);
84    virtual Value _getColUpperBound(int i) const;
85
86    virtual void _setRowLowerBound(int i, Value value);
87    virtual Value _getRowLowerBound(int i) const;
88
89    virtual void _setRowUpperBound(int i, Value value);
90    virtual Value _getRowUpperBound(int i) const;
91
92    virtual void _setObjCoeffs(ExprIterator b, ExprIterator e);
93    virtual void _getObjCoeffs(InsertIterator b) const;
94
95    virtual void _setObjCoeff(int i, Value obj_coef);
96    virtual Value _getObjCoeff(int i) const;
97
98    virtual void _setSense(Sense);
99    virtual Sense _getSense() const;
100
101    virtual void _clear();
102
103  public:
104
105    ///Pointer to the underlying GLPK data structure.
106    LPX *lpx() {return lp;}
107    ///Const pointer to the underlying GLPK data structure.
108    const LPX *lpx() const {return lp;}
109
110    ///Returns the constraint identifier understood by GLPK.
111    int lpxRow(Row r) const { return rows(id(r)); }
112
113    ///Returns the variable identifier understood by GLPK.
114    int lpxCol(Col c) const { return cols(id(c)); }
115
116  };
117
118  /// \brief Interface for the GLPK LP solver
119  ///
120  /// This class implements an interface for the GLPK LP solver.
121  ///\ingroup lp_group
122  class GlpkLp : public LpSolver, public GlpkBase {
123  public:
124
125    ///\e
126    GlpkLp();
127    ///\e
128    GlpkLp(const GlpkLp&);
129
130    ///\e
131    virtual GlpkLp* cloneSolver() const;
132    ///\e
133    virtual GlpkLp* newSolver() const;
134
135  private:
136
137    mutable std::vector<double> _primal_ray;
138    mutable std::vector<double> _dual_ray;
139
140    void _clear_temporals();
141
142  protected:
143
144    virtual const char* _solverName() const;
145
146    virtual SolveExitStatus _solve();
147    virtual Value _getPrimal(int i) const;
148    virtual Value _getDual(int i) const;
149
150    virtual Value _getPrimalValue() const;
151
152    virtual VarStatus _getColStatus(int i) const;
153    virtual VarStatus _getRowStatus(int i) const;
154
155    virtual Value _getPrimalRay(int i) const;
156    virtual Value _getDualRay(int i) const;
157
158    ///\todo It should be clarified
159    ///
160    virtual ProblemType _getPrimalType() const;
161    virtual ProblemType _getDualType() const;
162
163  public:
164
165    ///Solve with primal simplex
166    SolveExitStatus solvePrimal();
167
168    ///Solve with dual simplex
169    SolveExitStatus solveDual();
170
171    ///Turns on or off the presolver
172
173    ///Turns on (\c b is \c true) or off (\c b is \c false) the presolver
174    ///
175    ///The presolver is off by default.
176    void presolver(bool b);
177
178    ///Enum for \c messageLevel() parameter
179    enum MessageLevel {
180      /// no output (default value)
181      MESSAGE_NO_OUTPUT = 0,
182      /// error messages only
183      MESSAGE_ERROR_MESSAGE = 1,
184      /// normal output
185      MESSAGE_NORMAL_OUTPUT = 2,
186      /// full output (includes informational messages)
187      MESSAGE_FULL_OUTPUT = 3
188    };
189
190  private:
191
192    MessageLevel _message_level;
193
194  public:
195
196    ///Set the verbosity of the messages
197
198    ///Set the verbosity of the messages
199    ///
200    ///\param m is the level of the messages output by the solver routines.
201    void messageLevel(MessageLevel m);
202  };
203
204  /// \brief Interface for the GLPK MIP solver
205  ///
206  /// This class implements an interface for the GLPK MIP solver.
207  ///\ingroup lp_group
208  class GlpkMip : public MipSolver, public GlpkBase {
209  public:
210
211    ///\e
212    GlpkMip();
213    ///\e
214    GlpkMip(const GlpkMip&);
215
216    virtual GlpkMip* cloneSolver() const;
217    virtual GlpkMip* newSolver() const;
218
219  protected:
220
221    virtual const char* _solverName() const;
222
223    virtual ColTypes _getColType(int col) const;
224    virtual void _setColType(int col, ColTypes col_type);
225
226    virtual SolveExitStatus _solve();
227    virtual ProblemType _getType() const;
228    virtual Value _getSol(int i) const;
229    virtual Value _getSolValue() const;
230
231    ///Enum for \c messageLevel() parameter
232    enum MessageLevel {
233      /// no output (default value)
234      MESSAGE_NO_OUTPUT = 0,
235      /// error messages only
236      MESSAGE_ERROR_MESSAGE = 1,
237      /// normal output
238      MESSAGE_NORMAL_OUTPUT = 2,
239      /// full output (includes informational messages)
240      MESSAGE_FULL_OUTPUT = 3
241    };
242
243  private:
244
245    MessageLevel _message_level;
246
247  public:
248
249    ///Set the verbosity of the messages
250
251    ///Set the verbosity of the messages
252    ///
253    ///\param m is the level of the messages output by the solver routines.
254    void messageLevel(MessageLevel m);
255  };
256
257
258} //END OF NAMESPACE LEMON
259
260#endif //LEMON_GLPK_H
261
Note: See TracBrowser for help on using the repository browser.