Reorganize internal solver tests

miplearn/solvers/tests/__init__.py

@@ -2,22 +2,24 @@
 #  Copyright (C) 2020-2021, UChicago Argonne, LLC. All rights reserved.
 #  Released under the modified BSD license. See COPYING.md for more details.
 
-from miplearn.solvers.internal import InternalSolver
-from miplearn.instance.base import Instance
 from typing import Any
 
+from miplearn.solvers.internal import InternalSolver
 
-def assert_equals(left: Any, right: Any) -> None:
-    assert left == right, f"{left} != {right}"
+# NOTE:
+# This file is in the main source folder, so that it can be called from Julia.
 
 
-def test_internal_solver(
-    solver: InternalSolver,
-    instance: Instance,
-    model: Any,
-) -> None:
+def run_internal_solver_tests(solver: InternalSolver) -> None:
+    run_basic_usage_tests(solver.clone())
+    run_warm_start_tests(solver.clone())
+    run_infeasibility_tests(solver.clone())
+
+
+def run_basic_usage_tests(solver: InternalSolver) -> None:
+    instance = solver.build_test_instance_knapsack()
+    model = instance.to_model()
     solver.set_instance(instance, model)
-
     assert_equals(
         solver.get_variable_names(),
         ["x[0]", "x[1]", "x[2]", "x[3]"],
@@ -64,18 +66,129 @@ def test_internal_solver(
     assert_equals(solution["x[2]"], 1.0)
     assert_equals(solution["x[3]"], 1.0)
 
-    assert_equals(solver.get_constraint_ids(), ["eq_capacity"])
-    assert_equals(
-        solver.get_constraint_rhs("eq_capacity"),
-        67.0,
-    )
-    assert_equals(
-        solver.get_constraint_lhs("eq_capacity"),
-        {
-            "x[0]": 23.0,
-            "x[1]": 26.0,
-            "x[2]": 20.0,
-            "x[3]": 18.0,
-        },
-    )
-    assert_equals(solver.get_constraint_sense("eq_capacity"), "<")
+    # assert_equals(solver.get_constraint_ids(), ["eq_capacity"])
+    # assert_equals(
+    #     solver.get_constraint_rhs("eq_capacity"),
+    #     67.0,
+    # )
+    # assert_equals(
+    #     solver.get_constraint_lhs("eq_capacity"),
+    #     {
+    #         "x[0]": 23.0,
+    #         "x[1]": 26.0,
+    #         "x[2]": 20.0,
+    #         "x[3]": 18.0,
+    #     },
+    # )
+    # assert_equals(solver.get_constraint_sense("eq_capacity"), "<")
+
+    # if isinstance(solver, BasePyomoSolver):
+    #     model.cut = pe.Constraint(expr=model.x[0] <= 0.0, name="cut")
+    #     solver.add_constraint(model.cut)
+    # elif isinstance(solver, GurobiSolver):
+    #     x = model.getVarByName("x[0]")
+    #     solver.add_constraint(x <= 0.0, name="cut")
+    # else:
+    #     raise Exception("Illegal state")
+
+    # # Add a brand new constraint
+    cut = instance.build_lazy_constraint(model, "cut")
+    assert cut is not None
+    solver.add_constraint(cut, name="cut")
+
+    # New constraint should affect solution and should be listed in
+    # constraint ids
+    assert solver.get_constraint_ids() == ["eq_capacity", "cut"]
+    stats = solver.solve()
+    assert stats["Lower bound"] == 1030.0
+
+    assert solver.get_sense() == "max"
+    assert solver.get_constraint_sense("cut") == "<"
+    assert solver.get_constraint_sense("eq_capacity") == "<"
+
+    # Verify slacks
+    assert solver.get_inequality_slacks() == {
+        "cut": 0.0,
+        "eq_capacity": 3.0,
+    }
+
+    # # Extract the new constraint
+    # cobj = solver.extract_constraint("cut")
+    #
+    # # New constraint should no longer affect solution and should no longer
+    # # be listed in constraint ids
+    # assert solver.get_constraint_ids() == ["eq_capacity"]
+    # stats = solver.solve()
+    # assert stats["Lower bound"] == 1183.0
+    #
+    # # New constraint should not be satisfied by current solution
+    # assert not solver.is_constraint_satisfied(cobj)
+    #
+    # # Re-add constraint
+    # solver.add_constraint(cobj)
+    #
+    # # Constraint should affect solution again
+    # assert solver.get_constraint_ids() == ["eq_capacity", "cut"]
+    # stats = solver.solve()
+    # assert stats["Lower bound"] == 1030.0
+    #
+    # # New constraint should now be satisfied
+    # assert solver.is_constraint_satisfied(cobj)
+    #
+    # # Relax problem and make cut into an equality constraint
+    # solver.relax()
+    # solver.set_constraint_sense("cut", "=")
+    # stats = solver.solve()
+    # assert stats["Lower bound"] is not None
+    # assert round(stats["Lower bound"]) == 1030.0
+    # assert round(solver.get_dual("eq_capacity")) == 0.0
+
+
+def run_warm_start_tests(solver: InternalSolver) -> None:
+    instance = solver.build_test_instance_knapsack()
+    model = instance.to_model()
+    solver.set_instance(instance, model)
+    solver.set_warm_start({"x[0]": 1.0, "x[1]": 0.0, "x[2]": 0.0, "x[3]": 1.0})
+    stats = solver.solve(tee=True)
+    if stats["Warm start value"] is not None:
+        assert_equals(stats["Warm start value"], 725.0)
+
+    solver.set_warm_start({"x[0]": 1.0, "x[1]": 1.0, "x[2]": 1.0, "x[3]": 1.0})
+    stats = solver.solve(tee=True)
+    assert stats["Warm start value"] is None
+
+    solver.fix({"x[0]": 1.0, "x[1]": 0.0, "x[2]": 0.0, "x[3]": 1.0})
+    stats = solver.solve(tee=True)
+    assert stats["Lower bound"] == 725.0
+    assert stats["Upper bound"] == 725.0
+
+
+def run_infeasibility_tests(solver: InternalSolver) -> None:
+    instance = solver.build_test_instance_infeasible()
+    solver.set_instance(instance)
+    mip_stats = solver.solve()
+    assert solver.is_infeasible()
+    assert solver.get_solution() is None
+    assert mip_stats["Upper bound"] is None
+    assert mip_stats["Lower bound"] is None
+    lp_stats = solver.solve_lp()
+    assert solver.get_solution() is None
+    assert lp_stats["LP value"] is None
+
+
+def run_iteration_cb_tests(solver: InternalSolver) -> None:
+    instance = solver.build_test_instance_knapsack()
+    solver.set_instance(instance)
+    count = 0
+
+    def custom_iteration_cb() -> bool:
+        nonlocal count
+        count += 1
+        return count < 5
+
+    solver.solve(iteration_cb=custom_iteration_cb)
+    assert count == 5
+
+
+def assert_equals(left: Any, right: Any) -> None:
+    assert left == right, f"{left} != {right}"