1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
3 * This file is a part of LEMON, a generic C++ optimization library.
5 * Copyright (C) 2003-2009
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-CPLEX lp solver interface.
25 #include <lemon/lp_base.h>
32 /// \brief Reference counted wrapper around cpxenv pointer
34 /// The cplex uses environment object which is responsible for
35 /// checking the proper license usage. This class provides a simple
36 /// interface for share the environment object between different
39 friend class CplexBase;
46 /// \brief This exception is thrown when the license check is not
48 class LicenseError : public Exception {
49 friend class CplexEnv;
52 LicenseError(int status);
57 /// The short error message
58 virtual const char* what() const throw() {
65 /// Shallow copy constructor
66 CplexEnv(const CplexEnv&);
67 /// Shallow assignement
68 CplexEnv& operator=(const CplexEnv&);
74 cpxenv* cplexEnv() { return _env; }
75 const cpxenv* cplexEnv() const { return _env; }
78 /// \brief Base interface for the CPLEX LP and MIP solver
80 /// This class implements the common interface of the CPLEX LP and
83 class CplexBase : virtual public LpBase {
90 CplexBase(const CplexEnv&);
91 CplexBase(const CplexBase &);
94 virtual int _addCol();
95 virtual int _addRow();
97 virtual void _eraseCol(int i);
98 virtual void _eraseRow(int i);
100 virtual void _eraseColId(int i);
101 virtual void _eraseRowId(int i);
103 virtual void _getColName(int col, std::string& name) const;
104 virtual void _setColName(int col, const std::string& name);
105 virtual int _colByName(const std::string& name) const;
107 virtual void _getRowName(int row, std::string& name) const;
108 virtual void _setRowName(int row, const std::string& name);
109 virtual int _rowByName(const std::string& name) const;
111 virtual void _setRowCoeffs(int i, ExprIterator b, ExprIterator e);
112 virtual void _getRowCoeffs(int i, InsertIterator b) const;
114 virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e);
115 virtual void _getColCoeffs(int i, InsertIterator b) const;
117 virtual void _setCoeff(int row, int col, Value value);
118 virtual Value _getCoeff(int row, int col) const;
120 virtual void _setColLowerBound(int i, Value value);
121 virtual Value _getColLowerBound(int i) const;
123 virtual void _setColUpperBound(int i, Value value);
124 virtual Value _getColUpperBound(int i) const;
127 void _set_row_bounds(int i, Value lb, Value ub);
130 virtual void _setRowLowerBound(int i, Value value);
131 virtual Value _getRowLowerBound(int i) const;
133 virtual void _setRowUpperBound(int i, Value value);
134 virtual Value _getRowUpperBound(int i) const;
136 virtual void _setObjCoeffs(ExprIterator b, ExprIterator e);
137 virtual void _getObjCoeffs(InsertIterator b) const;
139 virtual void _setObjCoeff(int i, Value obj_coef);
140 virtual Value _getObjCoeff(int i) const;
142 virtual void _setSense(Sense sense);
143 virtual Sense _getSense() const;
145 virtual void _clear();
147 virtual void _messageLevel(MessageLevel level);
148 void _applyMessageLevel();
150 bool _message_enabled;
154 /// Returns the used \c CplexEnv instance
155 const CplexEnv& env() const { return _env; }
157 /// \brief Returns the const cpxenv pointer
159 /// \note The cpxenv might be destructed with the solver.
160 const cpxenv* cplexEnv() const { return _env.cplexEnv(); }
162 /// \brief Returns the const cpxenv pointer
164 /// \note The cpxenv might be destructed with the solver.
165 cpxenv* cplexEnv() { return _env.cplexEnv(); }
167 /// Returns the cplex problem object
168 cpxlp* cplexLp() { return _prob; }
169 /// Returns the cplex problem object
170 const cpxlp* cplexLp() const { return _prob; }
174 /// \brief Interface for the CPLEX LP solver
176 /// This class implements an interface for the CPLEX LP solver.
178 class CplexLp : public LpSolver, public CplexBase {
183 CplexLp(const CplexEnv&);
185 CplexLp(const CplexLp&);
190 virtual CplexLp* cloneSolver() const;
192 virtual CplexLp* newSolver() const;
196 // these values cannot retrieved element by element
197 mutable std::vector<int> _col_status;
198 mutable std::vector<int> _row_status;
200 mutable std::vector<Value> _primal_ray;
201 mutable std::vector<Value> _dual_ray;
203 void _clear_temporals();
205 SolveExitStatus convertStatus(int status);
209 virtual const char* _solverName() const;
211 virtual SolveExitStatus _solve();
212 virtual Value _getPrimal(int i) const;
213 virtual Value _getDual(int i) const;
214 virtual Value _getPrimalValue() const;
216 virtual VarStatus _getColStatus(int i) const;
217 virtual VarStatus _getRowStatus(int i) const;
219 virtual Value _getPrimalRay(int i) const;
220 virtual Value _getDualRay(int i) const;
222 virtual ProblemType _getPrimalType() const;
223 virtual ProblemType _getDualType() const;
227 /// Solve with primal simplex method
228 SolveExitStatus solvePrimal();
230 /// Solve with dual simplex method
231 SolveExitStatus solveDual();
233 /// Solve with barrier method
234 SolveExitStatus solveBarrier();
238 /// \brief Interface for the CPLEX MIP solver
240 /// This class implements an interface for the CPLEX MIP solver.
242 class CplexMip : public MipSolver, public CplexBase {
247 CplexMip(const CplexEnv&);
249 CplexMip(const CplexMip&);
254 virtual CplexMip* cloneSolver() const;
256 virtual CplexMip* newSolver() const;
261 virtual const char* _solverName() const;
263 virtual ColTypes _getColType(int col) const;
264 virtual void _setColType(int col, ColTypes col_type);
266 virtual SolveExitStatus _solve();
267 virtual ProblemType _getType() const;
268 virtual Value _getSol(int i) const;
269 virtual Value _getSolValue() const;
273 } //END OF NAMESPACE LEMON
275 #endif //LEMON_CPLEX_H