forked from coin-or/python-mip
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathsolver.py
317 lines (229 loc) · 7.92 KB
/
solver.py
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
"""This module implements the solver intependent communication layer of
Python-MIP
"""
from typing import List, Tuple, Optional, Union
import numbers
import mip
class Solver:
"""The solver is an abstract class with the solver independent
API to communicate with the solver engine"""
def __init__(self: "Solver", model: "Model", name: str = "", sense: str = ""):
self.model = model
if name:
self.name = name
if sense:
self.sense = sense
def __del__(self: "Solver"):
pass
def add_var(
self: "Solver",
name: str = "",
obj: numbers.Real = 0,
lb: numbers.Real = 0,
ub: numbers.Real = mip.INF,
var_type: str = mip.CONTINUOUS,
column: "Column" = None,
):
pass
def add_constr(self: "Solver", lin_expr: "mip.LinExpr", name: str = ""):
pass
def add_lazy_constr(self: "Solver", lin_expr: "mip.LinExpr"):
pass
def add_sos(
self: "Solver",
sos: List[Tuple["mip.Var", numbers.Real]],
sos_type: int,
):
pass
def add_cut(self: "Solver", lin_expr: "mip.LinExpr"):
pass
def get_objective_bound(self: "Solver") -> numbers.Real:
pass
def get_objective(self: "Solver") -> "mip.LinExpr":
pass
def get_objective_const(self: "Solver") -> numbers.Real:
pass
def relax(self: "Solver"):
pass
def generate_cuts(
self,
cut_types: Optional[List[mip.CutType]] = None,
depth: int = 0,
npass: int = 0,
max_cuts: int = mip.INT_MAX,
min_viol: numbers.Real = 1e-4,
) -> "mip.CutPool":
pass
def clique_merge(self, constrs: Optional[List["mip.Constr"]] = None):
pass
def optimize(
self: "Solver",
relax: bool = False,
) -> "mip.OptimizationStatus":
pass
def get_objective_value(self: "Solver") -> numbers.Real:
pass
def get_log(
self: "Solver",
) -> List[Tuple[numbers.Real, Tuple[numbers.Real, numbers.Real]]]:
return []
def get_objective_value_i(self: "Solver", i: int) -> numbers.Real:
pass
def get_num_solutions(self: "Solver") -> int:
pass
def get_objective_sense(self: "Solver") -> str:
pass
def set_objective_sense(self: "Solver", sense: str):
pass
def set_start(self: "Solver", start: List[Tuple["mip.Var", numbers.Real]]):
pass
def set_objective(self: "Solver", lin_expr: "mip.LinExpr", sense: str = ""):
pass
def set_objective_const(self: "Solver", const: numbers.Real):
pass
def set_processing_limits(
self: "Solver",
max_time: numbers.Real = mip.INF,
max_nodes: int = mip.INT_MAX,
max_sol: int = mip.INT_MAX,
max_seconds_same_incumbent: float = mip.INF,
max_nodes_same_incumbent: int = mip.INT_MAX,
):
pass
def get_max_seconds(self: "Solver") -> numbers.Real:
pass
def set_max_seconds(self: "Solver", max_seconds: numbers.Real):
pass
def get_max_solutions(self: "Solver") -> int:
pass
def set_max_solutions(self: "Solver", max_solutions: int):
pass
def get_pump_passes(self: "Solver") -> int:
pass
def set_pump_passes(self: "Solver", passes: int):
pass
def get_max_nodes(self: "Solver") -> int:
pass
def set_max_nodes(self: "Solver", max_nodes: int):
pass
def set_num_threads(self: "Solver", threads: int):
pass
def write(self: "Solver", file_path: str):
pass
def read(self: "Solver", file_path: str):
pass
def num_cols(self: "Solver") -> int:
pass
def num_rows(self: "Solver") -> int:
pass
def num_nz(self: "Solver") -> int:
pass
def num_int(self: "Solver") -> int:
pass
def get_emphasis(self: "Solver") -> mip.SearchEmphasis:
pass
def set_emphasis(self: "Solver", emph: mip.SearchEmphasis):
pass
def get_cutoff(self: "Solver") -> numbers.Real:
pass
def set_cutoff(self: "Solver", cutoff: numbers.Real):
pass
def get_mip_gap_abs(self: "Solver") -> numbers.Real:
pass
def set_mip_gap_abs(self: "Solver", mip_gap_abs: numbers.Real):
pass
def get_mip_gap(self: "Solver") -> numbers.Real:
pass
def set_mip_gap(self: "Solver", mip_gap: numbers.Real):
pass
def get_verbose(self: "Solver") -> int:
pass
def set_verbose(self: "Solver", verbose: int):
pass
# Constraint-related getters/setters
def constr_get_expr(self: "Solver", constr: "mip.Constr") -> "mip.LinExpr":
pass
def constr_set_expr(
self: "Solver", constr: "mip.Constr", value: "mip.LinExpr"
) -> "mip.LinExpr":
pass
def constr_get_rhs(self: "Solver", idx: int) -> numbers.Real:
pass
def constr_set_rhs(self: "Solver", idx: int, rhs: numbers.Real):
pass
def constr_get_name(self: "Solver", idx: int) -> str:
pass
def constr_get_pi(self: "Solver", constr: "mip.Constr") -> numbers.Real:
pass
def constr_get_slack(self: "Solver", constr: "mip.Constr") -> numbers.Real:
pass
def remove_constrs(self: "Solver", constrsList: List[int]):
pass
def constr_get_index(self: "Solver", name: str) -> int:
pass
# Variable-related getters/setters
def var_get_branch_priority(self: "Solver", var: "mip.Var") -> numbers.Real:
pass
def var_set_branch_priority(self: "Solver", var: "mip.Var", value: numbers.Real):
pass
def var_get_lb(self: "Solver", var: "mip.Var") -> numbers.Real:
pass
def var_set_lb(self: "Solver", var: "mip.Var", value: numbers.Real):
pass
def var_get_ub(self: "Solver", var: "mip.Var") -> numbers.Real:
pass
def var_set_ub(self: "Solver", var: "mip.Var", value: numbers.Real):
pass
def var_get_obj(self: "Solver", var: "mip.Var") -> numbers.Real:
pass
def var_set_obj(self: "Solver", var: "mip.Var", value: numbers.Real):
pass
def var_get_var_type(self: "Solver", var: "mip.Var") -> str:
pass
def var_set_var_type(self: "Solver", var: "mip.Var", value: str):
pass
def var_get_column(self: "Solver", var: "mip.Var") -> "Column":
pass
def var_set_column(self: "Solver", var: "mip.Var", value: "Column"):
pass
def var_get_rc(self: "Solver", var: "mip.Var") -> numbers.Real:
pass
def var_get_x(self: "Solver", var: "mip.Var") -> numbers.Real:
"""Assumes that the solution is available (should be checked
before calling it"""
def var_get_xi(self: "Solver", var: "mip.Var", i: int) -> numbers.Real:
pass
def var_get_name(self: "Solver", idx: int) -> str:
pass
def remove_vars(self: "Solver", varsList: List[int]):
pass
def var_get_index(self: "Solver", name: str) -> int:
pass
def get_problem_name(self: "Solver") -> str:
pass
def set_problem_name(self: "Solver", name: str):
pass
def get_status(self: "Solver") -> mip.OptimizationStatus:
pass
def cgraph_density(self: "Solver") -> float:
"""Density of the conflict graph"""
pass
def conflicting(
self: "Solver",
e1: Union["mip.LinExpr", "mip.Var"],
e2: Union["mip.LinExpr", "mip.Var"],
) -> bool:
"""Checks if two assignment to binary variables are in conflict,
returns none if no conflict graph is available"""
pass
def conflicting_nodes(
self: "Solver", v1: Union["mip.Var", "mip.LinExpr"]
) -> Tuple[List["mip.Var"], List["mip.Var"]]:
"""Returns all assignment conflicting with the assignment in v1 in the
conflict graph.
"""
pass
def feature_values(self: "Solver") -> List[float]:
pass
def feature_names(self: "Solver") -> List[str]:
pass