ommx-python-mip-adapter 2.2.0__tar.gz → 2.3.1__tar.gz

{ommx_python_mip_adapter-2.2.0 → ommx_python_mip_adapter-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ommx_python_mip_adapter
-Version: 2.2.0
+Version: 2.3.1
 Summary: An adapter for the Python-MIP from/to OMMX.
 Author-email: "Jij Inc." <info@j-ij.com>
 Project-URL: Repository, https://github.com/Jij-Inc/ommx

{ommx_python_mip_adapter-2.2.0 → ommx_python_mip_adapter-2.3.1}/ommx_python_mip_adapter/adapter.py

@@ -4,7 +4,12 @@ from typing import Optional
 
 import mip
 
-from ommx.adapter import SolverAdapter, InfeasibleDetected, UnboundedDetected
+from ommx.adapter import (
+    SolverAdapter,
+    InfeasibleDetected,
+    UnboundedDetected,
+    NoSolutionReturned,
+)
 from ommx.v1 import Instance, Constraint, DecisionVariable, Solution, State, Function
 
 from .exception import OMMXPythonMIPAdapterError
@@ -228,14 +233,6 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             42.0
 
         """
-        # TODO check if `optimize()` has been called
-
-        if data.status == mip.OptimizationStatus.INFEASIBLE:
-            raise InfeasibleDetected("Model was infeasible")
-
-        if data.status == mip.OptimizationStatus.UNBOUNDED:
-            raise UnboundedDetected("Model was unbounded")
-
         state = self.decode_to_state(data)
         solution = self.instance.evaluate(state)
 
@@ -285,12 +282,27 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             >>> ommx_state.entries
             {1: 0.0}
         """
+        if data.status == mip.OptimizationStatus.LOADED:
+            raise OMMXPythonMIPAdapterError(
+                "The model may not be optimized. [status: LOADED]"
+            )
+
+        if data.status == mip.OptimizationStatus.INFEASIBLE:
+            raise InfeasibleDetected("Model was infeasible")
+
+        if data.status == mip.OptimizationStatus.UNBOUNDED:
+            raise UnboundedDetected("Model was unbounded")
+
+        if data.status == mip.OptimizationStatus.NO_SOLUTION_FOUND:
+            raise NoSolutionReturned("No solution was returned during the search")
+
+        # Catch all other statuses (CUTOFF, ERROR, INT_INFEASIBLE, etc.)
         if not (
             data.status == mip.OptimizationStatus.OPTIMAL
             or data.status == mip.OptimizationStatus.FEASIBLE
         ):
             raise OMMXPythonMIPAdapterError(
-                " The model's `status` must be `OPTIMAL` or `FEASIBLE`."
+                f"Optimization ended with status: {data.status.name}"
             )
 
         return State(

{ommx_python_mip_adapter-2.2.0 → ommx_python_mip_adapter-2.3.1}/ommx_python_mip_adapter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ommx_python_mip_adapter
-Version: 2.2.0
+Version: 2.3.1
 Summary: An adapter for the Python-MIP from/to OMMX.
 Author-email: "Jij Inc." <info@j-ij.com>
 Project-URL: Repository, https://github.com/Jij-Inc/ommx

{ommx_python_mip_adapter-2.2.0 → ommx_python_mip_adapter-2.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ommx_python_mip_adapter"
-version = "2.2.0"
+version = "2.3.1"
 
 description = "An adapter for the Python-MIP from/to OMMX."
 authors = [{ name = "Jij Inc.", email = "info@j-ij.com" }]

{ommx_python_mip_adapter-2.2.0 → ommx_python_mip_adapter-2.3.1}/tests/test_integration.py

@@ -1,9 +1,11 @@
 import pytest
 
 from ommx.v1 import Instance, DecisionVariable, Solution
+from ommx.adapter import InfeasibleDetected, UnboundedDetected, NoSolutionReturned
 from ommx.testing import SingleFeasibleLPGenerator, DataType
 
 from ommx_python_mip_adapter import OMMXPythonMIPAdapter
+from ommx_python_mip_adapter.exception import OMMXPythonMIPAdapterError
 
 
 @pytest.mark.parametrize(
@@ -119,3 +121,83 @@ def test_relax_constraint():
     solution = OMMXPythonMIPAdapter.solve(instance)
     # x[2] is still present as part of the evaluate/decoding process but has a value of 0
     assert [var.value for var in solution.decision_variables] == [0, 0, 0]
+
+
+def test_integration_timelimit():
+    # KnapSack Problem
+    p = [10, 13, 18, 32, 7, 15, 12, 6, 22, 20, 19, 13, 11, 39, 10]
+    w = [11, 15, 20, 35, 10, 33, 28, 23, 11, 10, 12, 16, 17, 26, 29]
+    n = len(p)
+    x = [DecisionVariable.binary(i) for i in range(n)]
+    constraint = sum(w[i] * x[i] for i in range(n)) <= sum(w) // 2
+    assert not isinstance(constraint, bool)
+    instance = Instance.from_components(
+        decision_variables=x,
+        objective=sum(p[i] * x[i] for i in range(n)),
+        constraints=[constraint],
+        sense=Instance.MAXIMIZE,
+    )
+    adapter = OMMXPythonMIPAdapter(instance)
+    model = adapter.solver_input
+    # Set a very small time limit to force the solver to stop before finding any solution
+    model.max_seconds = 0.0001
+    model.optimize()
+
+    with pytest.raises(
+        NoSolutionReturned,
+        match="No solution was returned during the search",
+    ):
+        adapter.decode(model)
+
+
+def test_infeasible_problem():
+    # x must be >= 4, but upper bound is 3 -> infeasible
+    x = DecisionVariable.integer(0, lower=0, upper=3)
+    instance = Instance.from_components(
+        decision_variables=[x],
+        objective=x,
+        constraints=[x >= 4],
+        sense=Instance.MAXIMIZE,
+    )
+    adapter = OMMXPythonMIPAdapter(instance)
+    model = adapter.solver_input
+    model.optimize()
+
+    with pytest.raises(InfeasibleDetected):
+        adapter.decode_to_state(model)
+
+
+def test_unbounded_problem():
+    # x has no upper bound, maximize x -> unbounded
+    x = DecisionVariable.integer(0, lower=0)
+    instance = Instance.from_components(
+        decision_variables=[x],
+        objective=x,
+        constraints=[],
+        sense=Instance.MAXIMIZE,
+    )
+    adapter = OMMXPythonMIPAdapter(instance)
+    model = adapter.solver_input
+    model.optimize()
+
+    with pytest.raises(UnboundedDetected):
+        adapter.decode_to_state(model)
+
+
+def test_decode_before_optimize():
+    x = DecisionVariable.integer(0, lower=0, upper=5)
+    instance = Instance.from_components(
+        decision_variables=[x],
+        objective=x,
+        constraints=[],
+        sense=Instance.MINIMIZE,
+    )
+    adapter = OMMXPythonMIPAdapter(instance)
+    model = adapter.solver_input
+    # Do not call model.optimize()
+
+    with pytest.raises(
+        OMMXPythonMIPAdapterError,
+        match=r"The model may not be optimized. \[status: LOADED\]",
+    ):
+        adapter.decode_to_state(model)