| OpenMS 2.5.0

LPWrapper.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2020.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Alexandra Zerck $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/DATASTRUCTURES/String.h> // for String
38
39 #include <OpenMS/CONCEPT/Types.h>
40 #include <OpenMS/OpenMSConfig.h>
41 #include <OpenMS/config.h>
42
43 #include <limits>
44
45 // do NOT include glpk and CoinOr headers here, as they define bad stuff, which ripples through OpenMS then...
46 // include them in LPWrapper.cpp where they do not harm
47 // only declare them here
48 class CoinModel;
49
50 #ifndef GLP_PROB_DEFINED
51 #define GLP_PROB_DEFINED
52 // depending on the glpk version
53 // define glp_prob as forward or struct
54 #if OPENMS_GLPK_VERSION_MINOR < 48
55 typedef struct
56 {
57 double _opaque_prob[100];
58 } glp_prob;
59 #else
60 class glp_prob;
61 #endif
62 #endif
63
64 namespace OpenMS
65 {
66
67 class OPENMS_DLLAPI LPWrapper
68 {
69 public:
73 struct SolverParam
74 {
75 SolverParam() :
76 message_level(3), branching_tech(4), backtrack_tech(3),
77 preprocessing_tech(2), enable_feas_pump_heuristic(true), enable_gmi_cuts(true),
78 enable_mir_cuts(true), enable_cov_cuts(true), enable_clq_cuts(true), mip_gap(0.0),
79 time_limit((std::numeric_limits<Int>::max)()), output_freq(5000), output_delay(10000), enable_presolve(true),
80 enable_binarization(true)
81 {
82 }
83
84 Int message_level;
85 Int branching_tech;
86 Int backtrack_tech;
87 Int preprocessing_tech;
88 bool enable_feas_pump_heuristic;
89 bool enable_gmi_cuts;
90 bool enable_mir_cuts;
91 bool enable_cov_cuts;
92 bool enable_clq_cuts;
93 double mip_gap;
94 Int time_limit;
95 Int output_freq;
96 Int output_delay;
97 bool enable_presolve;
98 bool enable_binarization;
99 };
100
101 enum Type
102 {
103 UNBOUNDED = 1,
104 LOWER_BOUND_ONLY,
105 UPPER_BOUND_ONLY,
106 DOUBLE_BOUNDED,
107 FIXED
108 };
109
110 enum VariableType
111 {
112 CONTINUOUS = 1,
113 INTEGER,
114 BINARY
115 };
116
117 enum Sense
118 {
119 MIN = 1,
120 MAX
121 };
122
123 enum WriteFormat
124 {
125 FORMAT_LP = 0,
126 FORMAT_MPS,
127 FORMAT_GLPK
128 };
129
130 enum SOLVER
131 {
132 SOLVER_GLPK = 0
133 #if COINOR_SOLVER == 1
134 , SOLVER_COINOR
135 #endif
136 };
137
138 enum SolverStatus
139 {
140 UNDEFINED = 1,
141 OPTIMAL = 5,
142 FEASIBLE = 2,
143 NO_FEASIBLE_SOL = 4
144 };
145
146 LPWrapper();
147 virtual ~LPWrapper();
148
149 // problem creation/manipulation
151 Int addRow(const std::vector<Int>& row_indices, const std::vector<double>& row_values, const String& name);
153 Int addColumn();
155 Int addColumn(const std::vector<Int>& column_indices, const std::vector<double>& column_values, const String& name);
156
169 Int addRow(const std::vector<Int>& row_indices, const std::vector<double>& row_values,
170 const String& name, double lower_bound, double upper_bound, Type type);
171
182 Int addColumn(const std::vector<Int>& column_indices, const std::vector<double>& column_values, const String& name, double lower_bound, double upper_bound, Type type);
183
185 void deleteRow(Int index);
187 void setColumnName(Int index, const String& name);
189 String getColumnName(Int index);
191 String getRowName(Int index);
193 Int getRowIndex(const String& name);
195 Int getColumnIndex(const String& name);
197 double getColumnUpperBound(Int index);
199 double getColumnLowerBound(Int index);
201 double getRowUpperBound(Int index);
203 double getRowLowerBound(Int index);
205 void setRowName(Int index, const String& name);
206
215 void setColumnBounds(Int index, double lower_bound, double upper_bound, Type type);
216
225 void setRowBounds(Int index, double lower_bound, double upper_bound, Type type);
226
233 void setColumnType(Int index, VariableType type);
234
241 VariableType getColumnType(Int index);
242
244 void setObjective(Int index, double obj_value);
246 double getObjective(Int index);
247
253 void setObjectiveSense(Sense sense);
254 Sense getObjectiveSense();
255
257 Int getNumberOfColumns();
259 Int getNumberOfRows();
260
261 void setElement(Int row_index, Int column_index, double value);
262 double getElement(Int row_index, Int column_index);
263
264 // problem reading/writing
271 void readProblem(const String& filename, const String& format);
272
279 void writeProblem(const String& filename, const WriteFormat format) const;
280
291 Int solve(SolverParam& solver_param, const Size verbose_level = 0);
292
298 SolverStatus getStatus();
299
300 // solution access
301 double getObjectiveValue();
302 double getColumnValue(Int index);
303
304 Int getNumberOfNonZeroEntriesInRow(Int idx);
305 void getMatrixRow(Int idx, std::vector<Int>& indexes);
306
309 void setSolver(const SOLVER s);
310
312 SOLVER getSolver() const;
313
314 protected:
315 #if COINOR_SOLVER == 1
316 CoinModel * model_ = nullptr;
317 std::vector<double> solution_;
318 #endif
319
320 glp_prob * lp_problem_ = nullptr;
321
322 SOLVER solver_;
323
324
325 }; // class
326
327 } // namespace
328
OpenMS::LPWrapper::Sense
Sense
Definition: LPWrapper.h:117
OpenMS::LPWrapper::INTEGER
Definition: LPWrapper.h:113
OpenMS::LPWrapper::SolverParam::enable_clq_cuts
bool enable_clq_cuts
Definition: LPWrapper.h:92
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::LPWrapper::SolverStatus
SolverStatus
Definition: LPWrapper.h:138
OpenMS::LPWrapper::WriteFormat
WriteFormat
Definition: LPWrapper.h:123
OpenMS::LPWrapper::UPPER_BOUND_ONLY
Definition: LPWrapper.h:105
OpenMS::LPWrapper::SolverParam::time_limit
Int time_limit
Definition: LPWrapper.h:94
OpenMS::LPWrapper::SolverParam::backtrack_tech
Int backtrack_tech
Definition: LPWrapper.h:86
OpenMS::IntensityAveragingMethod::MIN
OpenMS::LPWrapper
Definition: LPWrapper.h:67
OpenMS::LPWrapper::SolverParam::branching_tech
Int branching_tech
Definition: LPWrapper.h:85
OpenMS::LPWrapper::LOWER_BOUND_ONLY
Definition: LPWrapper.h:104
OpenMS::LPWrapper::VariableType
VariableType
Definition: LPWrapper.h:110
OpenMS::LPWrapper::SolverParam::enable_cov_cuts
bool enable_cov_cuts
Definition: LPWrapper.h:91
std
STL namespace.
Types.h
OpenMS::LPWrapper::SolverParam::mip_gap
double mip_gap
Definition: LPWrapper.h:93
glp_prob
Definition: LPWrapper.h:55
OpenMS::LPWrapper::Type
Type
Definition: LPWrapper.h:101
OpenMS::LPWrapper::SolverParam::enable_gmi_cuts
bool enable_gmi_cuts
Definition: LPWrapper.h:89
OpenMS::LPWrapper::SolverParam::preprocessing_tech
Int preprocessing_tech
Definition: LPWrapper.h:87
OpenMS::LPWrapper::SolverParam::output_freq
Int output_freq
Definition: LPWrapper.h:95
OpenMS::IntensityAveragingMethod::MAX
String.h
OpenMS::LPWrapper::DOUBLE_BOUNDED
Definition: LPWrapper.h:106
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::LPWrapper::SolverParam::output_delay
Int output_delay
Definition: LPWrapper.h:96
OpenMS::LPWrapper::SolverParam
Struct that holds the parameters of the LP solver.
Definition: LPWrapper.h:73
OpenMS::LPWrapper::SolverParam::enable_mir_cuts
bool enable_mir_cuts
Definition: LPWrapper.h:90
OpenMS::LPWrapper::FORMAT_MPS
Definition: LPWrapper.h:126
OpenMS::LPWrapper::SolverParam::enable_presolve
bool enable_presolve
Definition: LPWrapper.h:97
OpenMS::LPWrapper::SolverParam::enable_binarization
bool enable_binarization
only with presolve
Definition: LPWrapper.h:98
int
OpenMS::LPWrapper::solver_
SOLVER solver_
Definition: LPWrapper.h:322
OpenMS::LPWrapper::SolverParam::enable_feas_pump_heuristic
bool enable_feas_pump_heuristic
Definition: LPWrapper.h:88
OpenMS::LPWrapper::SolverParam::message_level
Int message_level
Definition: LPWrapper.h:84
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
OpenMS::LPWrapper::SOLVER
SOLVER
Definition: LPWrapper.h:130
OpenMS::LPWrapper::SolverParam::SolverParam
SolverParam()
Definition: LPWrapper.h:75