1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/* -*- mode: C++; indent-tabs-mode: nil; -*-
*
* This file is a part of LEMON, a generic C++ optimization library.
*
* Copyright (C) 2003-2013
* Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
* (Egervary Research Group on Combinatorial Optimization, EGRES).
*
* Permission to use, modify and distribute this software is granted
* provided that this copyright notice appears in all copies. For
* precise terms see the accompanying LICENSE file.
*
* This software is provided "AS IS" with no warranty of any kind,
* express or implied, and with no claim as to its suitability for any
* purpose.
*
*/
#ifndef LEMON_LP_SKELETON_H
#define LEMON_LP_SKELETON_H
#include <lemon/lp_base.h>
///\file
///\brief Skeleton file to implement LP/MIP solver interfaces
///
///The classes in this file do nothing, but they can serve as skeletons when
///implementing an interface to new solvers.
namespace lemon {
///A skeleton class to implement LP/MIP solver base interface
///This class does nothing, but it can serve as a skeleton when
///implementing an interface to new solvers.
class SkeletonSolverBase : public virtual LpBase {
int col_num,row_num;
protected:
SkeletonSolverBase()
: col_num(-1), row_num(-1) {}
/// \e
virtual int _addCol();
/// \e
virtual int _addRow();
/// \e
virtual int _addRow(Value l, ExprIterator b, ExprIterator e, Value u);
/// \e
virtual void _eraseCol(int i);
/// \e
virtual void _eraseRow(int i);
/// \e
virtual void _getColName(int col, std::string& name) const;
/// \e
virtual void _setColName(int col, const std::string& name);
/// \e
virtual int _colByName(const std::string& name) const;
/// \e
virtual void _getRowName(int row, std::string& name) const;
/// \e
virtual void _setRowName(int row, const std::string& name);
/// \e
virtual int _rowByName(const std::string& name) const;
/// \e
virtual void _setRowCoeffs(int i, ExprIterator b, ExprIterator e);
/// \e
virtual void _getRowCoeffs(int i, InsertIterator b) const;
/// \e
virtual void _setColCoeffs(int i, ExprIterator b, ExprIterator e);
/// \e
virtual void _getColCoeffs(int i, InsertIterator b) const;
/// Set one element of the coefficient matrix
virtual void _setCoeff(int row, int col, Value value);
/// Get one element of the coefficient matrix
virtual Value _getCoeff(int row, int col) const;
/// The lower bound of a variable (column) have to be given by an
/// extended number of type Value, i.e. a finite number of type
/// Value or -\ref INF.
virtual void _setColLowerBound(int i, Value value);
/// \e
/// The lower bound of a variable (column) is an
/// extended number of type Value, i.e. a finite number of type
/// Value or -\ref INF.
virtual Value _getColLowerBound(int i) const;
/// The upper bound of a variable (column) have to be given by an
/// extended number of type Value, i.e. a finite number of type
/// Value or \ref INF.
virtual void _setColUpperBound(int i, Value value);
/// \e
/// The upper bound of a variable (column) is an
/// extended number of type Value, i.e. a finite number of type
/// Value or \ref INF.
virtual Value _getColUpperBound(int i) const;
/// The lower bound of a constraint (row) have to be given by an
/// extended number of type Value, i.e. a finite number of type
/// Value or -\ref INF.
virtual void _setRowLowerBound(int i, Value value);
/// \e
/// The lower bound of a constraint (row) is an
/// extended number of type Value, i.e. a finite number of type
/// Value or -\ref INF.
virtual Value _getRowLowerBound(int i) const;
/// The upper bound of a constraint (row) have to be given by an
/// extended number of type Value, i.e. a finite number of type
/// Value or \ref INF.
virtual void _setRowUpperBound(int i, Value value);
/// \e
/// The upper bound of a constraint (row) is an
/// extended number of type Value, i.e. a finite number of type
/// Value or \ref INF.
virtual Value _getRowUpperBound(int i) const;
/// \e
virtual void _setObjCoeffs(ExprIterator b, ExprIterator e);
/// \e
virtual void _getObjCoeffs(InsertIterator b) const;
/// \e
virtual void _setObjCoeff(int i, Value obj_coef);
/// \e
virtual Value _getObjCoeff(int i) const;
///\e
virtual void _setSense(Sense);
///\e
virtual Sense _getSense() const;
///\e
virtual void _clear();
///\e
virtual void _messageLevel(MessageLevel);
///\e
virtual void _write(std::string file, std::string format) const;
};
/// \brief Skeleton class for an LP solver interface
///
///This class does nothing, but it can serve as a skeleton when
///implementing an interface to new solvers.
///\ingroup lp_group
class LpSkeleton : public LpSolver, public SkeletonSolverBase {
public:
///\e
LpSkeleton() : LpSolver(), SkeletonSolverBase() {}
///\e
virtual LpSkeleton* newSolver() const;
///\e
virtual LpSkeleton* cloneSolver() const;
protected:
///\e
virtual SolveExitStatus _solve();
///\e
virtual Value _getPrimal(int i) const;
///\e
virtual Value _getDual(int i) const;
///\e
virtual Value _getPrimalValue() const;
///\e
virtual Value _getPrimalRay(int i) const;
///\e
virtual Value _getDualRay(int i) const;
///\e
virtual ProblemType _getPrimalType() const;
///\e
virtual ProblemType _getDualType() const;
///\e
virtual VarStatus _getColStatus(int i) const;
///\e
virtual VarStatus _getRowStatus(int i) const;
///\e
virtual const char* _solverName() const;
};
/// \brief Skeleton class for a MIP solver interface
///
///This class does nothing, but it can serve as a skeleton when
///implementing an interface to new solvers.
///\ingroup lp_group
class MipSkeleton : public MipSolver, public SkeletonSolverBase {
public:
///\e
MipSkeleton() : MipSolver(), SkeletonSolverBase() {}
///\e
virtual MipSkeleton* newSolver() const;
///\e
virtual MipSkeleton* cloneSolver() const;
protected:
///\e
virtual SolveExitStatus _solve();
///\e
virtual Value _getSol(int i) const;
///\e
virtual Value _getSolValue() const;
///\e
virtual ProblemType _getType() const;
///\e
virtual const char* _solverName() const;
};
} //namespace lemon
#endif
|
