forked from google/or-tools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CpSolverTest.java
260 lines (219 loc) · 8.48 KB
/
CpSolverTest.java
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
// Copyright 2010-2021 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.ortools.sat;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import com.google.ortools.Loader;
import com.google.ortools.sat.CpSolverStatus;
import java.util.function.Consumer;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/** Tests the CpSolver java interface. */
public final class CpSolverTest {
@BeforeEach
public void setUp() {
Loader.loadNativeLibraries();
}
static class SolutionCounter extends CpSolverSolutionCallback {
public SolutionCounter() {}
@Override
public void onSolutionCallback() {
solutionCount++;
}
private int solutionCount;
public int getSolutionCount() {
return solutionCount;
}
}
static class LogToString {
public LogToString() {
logBuilder = new StringBuilder();
}
public void newMessage(String message) {
logBuilder.append(message).append("\n");
}
private final StringBuilder logBuilder;
public String getLog() {
return logBuilder.toString();
}
}
@Test
public void testCpSolver_solve() throws Exception {
final CpModel model = new CpModel();
assertNotNull(model);
// Creates the variables.
int numVals = 3;
final IntVar x = model.newIntVar(0, numVals - 1, "x");
final IntVar y = model.newIntVar(0, numVals - 1, "y");
// Creates the constraints.
model.addDifferent(x, y);
// Creates a solver and solves the model.
final CpSolver solver = new CpSolver();
assertNotNull(solver);
final CpSolverStatus status = solver.solve(model);
assertThat(status).isEqualTo(CpSolverStatus.OPTIMAL);
assertThat(solver.value(x)).isNotEqualTo(solver.value(y));
final String stats = solver.responseStats();
assertThat(stats).isNotEmpty();
}
@Test
public void testCpSolver_hinting() throws Exception {
final CpModel model = new CpModel();
assertNotNull(model);
final IntVar x = model.newIntVar(0, 5, "x");
final IntVar y = model.newIntVar(0, 6, "y");
// Creates the constraints.
model.addEquality(LinearExpr.sum(new IntVar[] {x, y}), 6);
// Add hints.
model.addHint(x, 2);
model.addHint(y, 4);
// Creates a solver and solves the model.
final CpSolver solver = new CpSolver();
assertNotNull(solver);
solver.getParameters().setCpModelPresolve(false);
final CpSolverStatus status = solver.solve(model);
assertThat(status).isEqualTo(CpSolverStatus.OPTIMAL);
assertThat(solver.value(x)).isEqualTo(2);
assertThat(solver.value(y)).isEqualTo(4);
}
@Test
public void testCpSolver_booleanValue() throws Exception {
final CpModel model = new CpModel();
assertNotNull(model);
final IntVar x = model.newBoolVar("x");
final IntVar y = model.newBoolVar("y");
model.addBoolOr(new Literal[] {x, y.not()});
// Creates a solver and solves the model.
final CpSolver solver = new CpSolver();
assertNotNull(solver);
final CpSolverStatus status = solver.solve(model);
assertEquals(CpSolverStatus.OPTIMAL, status);
assertThat(solver.booleanValue(x) || solver.booleanValue(y.not())).isTrue();
}
@Test
public void testCpSolver_searchAllSolutions() throws Exception {
final CpModel model = new CpModel();
assertNotNull(model);
// Creates the variables.
int numVals = 3;
final IntVar x = model.newIntVar(0, numVals - 1, "x");
final IntVar y = model.newIntVar(0, numVals - 1, "y");
model.newIntVar(0, numVals - 1, "z");
// Creates the constraints.
model.addDifferent(x, y);
// Creates a solver and solves the model.
final CpSolver solver = new CpSolver();
assertNotNull(solver);
final SolutionCounter cb = new SolutionCounter();
solver.searchAllSolutions(model, cb);
assertThat(cb.getSolutionCount()).isEqualTo(18);
assertThat(solver.numBranches()).isGreaterThan(0L);
}
@Test
public void testCpSolver_objectiveValue() throws Exception {
final CpModel model = new CpModel();
assertNotNull(model);
// Creates the variables.
final int numVals = 3;
final IntVar x = model.newIntVar(0, numVals - 1, "x");
final IntVar y = model.newIntVar(0, numVals - 1, "y");
final IntVar z = model.newIntVar(0, numVals - 1, "z");
// Creates the constraints.
model.addDifferent(x, y);
// Maximizes a linear combination of variables.
model.maximize(LinearExpr.scalProd(new IntVar[] {x, y, z}, new int[] {1, 2, 3}));
// Creates a solver and solves the model.
final CpSolver solver = new CpSolver();
assertNotNull(solver);
CpSolverStatus status = solver.solve(model);
assertThat(status).isEqualTo(CpSolverStatus.OPTIMAL);
assertThat(solver.objectiveValue()).isEqualTo(11.0);
}
@Test
public void testCpModel_crashPresolve() throws Exception {
final CpModel model = new CpModel();
assertNotNull(model);
// Create decision variables
final IntVar x = model.newIntVar(0, 5, "x");
final IntVar y = model.newIntVar(0, 5, "y");
// Create a linear constraint which enforces that only x or y can be greater than 0.
model.addLinearConstraint(LinearExpr.sum(new IntVar[] {x, y}), 0, 1);
// Create the objective variable
final IntVar obj = model.newIntVar(0, 3, "obj");
// Cut the domain of the objective variable
model.addGreaterOrEqual(obj, 2);
// Set a constraint that makes the problem infeasible
model.addMaxEquality(obj, new IntVar[] {x, y});
// Optimize objective
model.minimize(obj);
// Create a solver and solve the model.
final CpSolver solver = new CpSolver();
assertNotNull(solver);
com.google.ortools.sat.CpSolverStatus status = solver.solve(model);
assertThat(status).isEqualTo(CpSolverStatus.INFEASIBLE);
}
@Test
public void testCpSolver_customLog() throws Exception {
final CpModel model = new CpModel();
assertNotNull(model);
// Creates the variables.
final int numVals = 3;
final IntVar x = model.newIntVar(0, numVals - 1, "x");
final IntVar y = model.newIntVar(0, numVals - 1, "y");
// Creates the constraints.
model.addDifferent(x, y);
// Creates a solver and solves the model.
final CpSolver solver = new CpSolver();
assertNotNull(solver);
StringBuilder logBuilder = new StringBuilder();
Consumer<String> appendToLog = (String message) -> logBuilder.append(message).append('\n');
solver.setLogCallback(appendToLog);
solver.getParameters().setLogToStdout(false).setLogSearchProgress(true);
CpSolverStatus status = solver.solve(model);
assertThat(status).isEqualTo(CpSolverStatus.OPTIMAL);
String log = logBuilder.toString();
assertThat(log).isNotEmpty();
assertThat(log).contains("Parameters");
assertThat(log).contains("log_to_stdout: false");
assertThat(log).contains("OPTIMAL");
}
@Test
public void testCpSolver_customLogMultiThread() {
final CpModel model = new CpModel();
assertNotNull(model);
// Creates the variables.
int numVals = 3;
IntVar x = model.newIntVar(0, numVals - 1, "x");
IntVar y = model.newIntVar(0, numVals - 1, "y");
// Creates the constraints.
model.addDifferent(x, y);
// Creates a solver and solves the model.
final CpSolver solver = new CpSolver();
assertNotNull(solver);
StringBuilder logBuilder = new StringBuilder();
Consumer<String> appendToLog = (String message) -> logBuilder.append(message).append('\n');
solver.setLogCallback(appendToLog);
solver.getParameters()
.setLogToStdout(false)
.setLogSearchProgress(true)
.setNumSearchWorkers(12);
CpSolverStatus status = solver.solve(model);
assertThat(status).isEqualTo(CpSolverStatus.OPTIMAL);
String log = logBuilder.toString();
assertThat(log).isNotEmpty();
assertThat(log).contains("Parameters");
assertThat(log).contains("log_to_stdout: false");
assertThat(log).contains("OPTIMAL");
}
}