ommx-python-mip-adapter 2.5.1__tar.gz → 3.0.0a2__tar.gz

{ommx_python_mip_adapter-2.5.1 → ommx_python_mip_adapter-3.0.0a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ommx_python_mip_adapter
-Version: 2.5.1
+Version: 3.0.0a2
 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
@@ -15,7 +15,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: ommx<3.0.0,>=2.0.0b3
+Requires-Dist: ommx<4.0.0,>=3.0.0a2
 Requires-Dist: mip<2.0.0,>=1.17.0
 Requires-Dist: cffi<2.0.0,>=1.15.0
 
@@ -73,7 +73,7 @@ x1 = DecisionVariable.integer(1, lower=0, upper=5)
 ommx_instance = Instance.from_components(
     decision_variables=[x1],
     objective=x1,
-    constraints=[],
+    constraints={},
     sense=Instance.MINIMIZE,
 )
 

{ommx_python_mip_adapter-2.5.1 → ommx_python_mip_adapter-3.0.0a2}/README.md

@@ -52,7 +52,7 @@ x1 = DecisionVariable.integer(1, lower=0, upper=5)
 ommx_instance = Instance.from_components(
     decision_variables=[x1],
     objective=x1,
-    constraints=[],
+    constraints={},
     sense=Instance.MINIMIZE,
 )
 

{ommx_python_mip_adapter-2.5.1 → ommx_python_mip_adapter-3.0.0a2}/ommx_python_mip_adapter/adapter.py

@@ -32,6 +32,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
         :param solver: Passes a specific solver to the Python-MIP model.
         :param verbose: If True, enable Python-MIP's verbose mode
         """
+        super().__init__(ommx_instance)
         if ommx_instance.sense == Instance.MAXIMIZE:
             sense = mip.MAXIMIZE
         elif ommx_instance.sense == Instance.MINIMIZE:
@@ -89,7 +90,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             >>> instance = Instance.from_components(
             ...     decision_variables=x,
             ...     objective=sum(p[i] * x[i] for i in range(6)),
-            ...     constraints=[(sum(w[i] * x[i] for i in range(6)) <= 47).set_id(0)],
+            ...     constraints={0: sum(w[i] * x[i] for i in range(6)) <= 47},
             ...     sense=Instance.MAXIMIZE,
             ... )
 
@@ -124,7 +125,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
                 >>> instance = Instance.from_components(
                 ...     decision_variables=[x],
                 ...     objective=x,
-                ...     constraints=[x >= 4],
+                ...     constraints={0: x >= 4},
                 ...     sense=Instance.MAXIMIZE,
                 ... )
 
@@ -144,7 +145,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
                 >>> instance = Instance.from_components(
                 ...     decision_variables=[x],
                 ...     objective=x,
-                ...     constraints=[],
+                ...     constraints={},
                 ...     sense=Instance.MAXIMIZE,
                 ... )
 
@@ -165,7 +166,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
                 >>> instance = Instance.from_components(
                 ...     decision_variables=[x, y],
                 ...     objective=x + y,
-                ...     constraints=[(x + y <= 1).set_id(0)],
+                ...     constraints={0: x + y <= 1},
                 ...     sense=Instance.MAXIMIZE,
                 ... )
 
@@ -201,7 +202,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
         be set _only_ if `relax=True` was passed to the constructor. There is no
         way for this adapter to get relaxation information from Python-MIP
         directly. If relaxing the model separately after obtaining it with
-        `solver_input`, you must set `solution.raw.relaxation` yourself if you
+        `solver_input`, you must set `solution.relaxation` yourself if you
         care about this value.
 
         Examples
@@ -218,7 +219,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             >>> instance = Instance.from_components(
             ...     decision_variables=x,
             ...     objective=sum(p[i] * x[i] for i in range(6)),
-            ...     constraints=[sum(w[i] * x[i] for i in range(6)) <= 47],
+            ...     constraints={0: sum(w[i] * x[i] for i in range(6)) <= 47},
             ...     sense=Instance.MAXIMIZE,
             ... )
 
@@ -229,7 +230,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             <OptimizationStatus.OPTIMAL: 0>
 
             >>> solution = adapter.decode(model)
-            >>> solution.raw.objective
+            >>> solution.objective
             42.0
 
         """
@@ -270,7 +271,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             >>> ommx_instance = Instance.from_components(
             ...     decision_variables=[x1],
             ...     objective=x1,
-            ...     constraints=[],
+            ...     constraints={},
             ...     sense=Instance.MINIMIZE,
             ... )
             >>> adapter = OMMXPythonMIPAdapter(ommx_instance)
@@ -368,7 +369,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
         self.model.objective = self._as_lin_expr(self.instance.objective)
 
     def _set_constraints(self):
-        for constraint in self.instance.constraints:
+        for cid, constraint in self.instance.constraints.items():
             lin_expr = self._as_lin_expr(constraint.function)
             if constraint.equality == Constraint.EQUAL_TO_ZERO:
                 constr_expr = lin_expr == 0
@@ -377,6 +378,6 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             else:
                 raise OMMXPythonMIPAdapterError(
                     f"Not supported constraint equality: "
-                    f"id: {constraint.id}, equality: {constraint.equality}"
+                    f"id: {cid}, equality: {constraint.equality}"
                 )
-            self.model.add_constr(constr_expr, name=str(constraint.id))
+            self.model.add_constr(constr_expr, name=str(cid))

{ommx_python_mip_adapter-2.5.1 → ommx_python_mip_adapter-3.0.0a2}/ommx_python_mip_adapter/python_mip_to_ommx.py

@@ -72,8 +72,8 @@ class OMMXInstanceBuilder:
 
         return self.as_ommx_function(objective)
 
-    def constraints(self) -> list[Constraint]:
-        constraints = []
+    def constraints(self) -> dict[int, Constraint]:
+        constraints: dict[int, Constraint] = {}
 
         for constr in self.model.constrs:
             id = constr.idx
@@ -82,14 +82,12 @@ class OMMXInstanceBuilder:
 
             if lin_expr.sense == "=":
                 constraint = Constraint(
-                    id=id,
                     function=self.as_ommx_function(lin_expr),
                     equality=Constraint.EQUAL_TO_ZERO,
                     name=name,
                 )
             elif lin_expr.sense == "<":
                 constraint = Constraint(
-                    id=id,
                     function=self.as_ommx_function(lin_expr),
                     equality=Constraint.LESS_THAN_OR_EQUAL_TO_ZERO,
                     name=name,
@@ -98,7 +96,6 @@ class OMMXInstanceBuilder:
                 # `ommx.v1.Constraint` does not support `GREATER_THAN_OR_EQUAL_TO_ZERO`.
                 # So multiply the linear expression by -1.
                 constraint = Constraint(
-                    id=id,
                     function=self.as_ommx_function(-lin_expr),
                     equality=Constraint.LESS_THAN_OR_EQUAL_TO_ZERO,
                     name=name,
@@ -109,7 +106,7 @@ class OMMXInstanceBuilder:
                     f"name: {constr.name}, sense: {lin_expr.sense}"
                 )
 
-            constraints.append(constraint)
+            constraints[id] = constraint
 
         return constraints
 

{ommx_python_mip_adapter-2.5.1 → ommx_python_mip_adapter-3.0.0a2}/ommx_python_mip_adapter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ommx_python_mip_adapter
-Version: 2.5.1
+Version: 3.0.0a2
 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
@@ -15,7 +15,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: ommx<3.0.0,>=2.0.0b3
+Requires-Dist: ommx<4.0.0,>=3.0.0a2
 Requires-Dist: mip<2.0.0,>=1.17.0
 Requires-Dist: cffi<2.0.0,>=1.15.0
 
@@ -73,7 +73,7 @@ x1 = DecisionVariable.integer(1, lower=0, upper=5)
 ommx_instance = Instance.from_components(
     decision_variables=[x1],
     objective=x1,
-    constraints=[],
+    constraints={},
     sense=Instance.MINIMIZE,
 )
 

{ommx_python_mip_adapter-2.5.1 → ommx_python_mip_adapter-3.0.0a2}/ommx_python_mip_adapter.egg-info/requires.txt

@@ -1,3 +1,3 @@
-ommx<3.0.0,>=2.0.0b3
+ommx<4.0.0,>=3.0.0a2
 mip<2.0.0,>=1.17.0
 cffi<2.0.0,>=1.15.0

{ommx_python_mip_adapter-2.5.1 → ommx_python_mip_adapter-3.0.0a2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ommx_python_mip_adapter"
-version = "2.5.1"
+version = "3.0.0a2"
 
 description = "An adapter for the Python-MIP from/to OMMX."
 authors = [{ name = "Jij Inc.", email = "info@j-ij.com" }]
@@ -23,7 +23,7 @@ classifiers = [
 ]
 
 dependencies = [
-  "ommx >= 2.0.0b3, < 3.0.0",
+  "ommx >= 3.0.0a2, < 4.0.0",
   "mip >= 1.17.0, < 2.0.0",
   "cffi >= 1.15.0, < 2.0.0",
 ]

{ommx_python_mip_adapter-2.5.1 → ommx_python_mip_adapter-3.0.0a2}/tests/test_adapter.py

@@ -10,7 +10,7 @@ def test_error_nonlinear_objective():
     ommx_instance = Instance.from_components(
         decision_variables=[x],
         objective=2.3 * x * x,
-        constraints=[],
+        constraints={},
         sense=Instance.MINIMIZE,
     )
 
@@ -29,7 +29,7 @@ def test_error_nonlinear_constraint():
     ommx_instance = Instance.from_components(
         decision_variables=[x],
         objective=0.0,
-        constraints=[(2.3 * x * x == 0).set_id(0)],
+        constraints={0: 2.3 * x * x == 0},
         sense=Instance.MINIMIZE,
     )
 

{ommx_python_mip_adapter-2.5.1 → ommx_python_mip_adapter-3.0.0a2}/tests/test_constant_constraint.py

@@ -12,11 +12,11 @@ def test_constant_constraint_feasible():
     instance = Instance.from_components(
         decision_variables=[x],
         objective=x,
-        constraints=[
-            # 1 >= 0 is always true
+        constraints={
+            0:  # 1 >= 0 is always true
             Linear(terms={}, constant=1) >= 0,
-            x <= 1,
-        ],
+            1: x <= 1,
+        },
         sense=Instance.MAXIMIZE,
     )
     solution = OMMXPythonMIPAdapter.solve(instance)
@@ -35,11 +35,11 @@ def test_constant_constraint_infeasible():
     instance = Instance.from_components(
         decision_variables=[x],
         objective=x,
-        constraints=[
-            # -1 >= 0 is always false
+        constraints={
+            0:  # -1 >= 0 is always false
             Linear(terms={}, constant=-1) >= 0,
-            x <= 1,
-        ],
+            1: x <= 1,
+        },
         sense=Instance.MAXIMIZE,
     )
     with pytest.raises(InfeasibleDetected):

{ommx_python_mip_adapter-2.5.1 → ommx_python_mip_adapter-3.0.0a2}/tests/test_integration.py

@@ -48,10 +48,7 @@ def test_integration_milp():
     ommx_instance = Instance.from_components(
         decision_variables=[x1, x2],
         objective=-x1 - x2,
-        constraints=[
-            3 * x1 - x2 <= 6,
-            -x1 + 3 * x2 <= 6,
-        ],
+        constraints={0: 3 * x1 - x2 <= 6, 1: -x1 + 3 * x2 <= 6},
         sense=Instance.MINIMIZE,
     )
 
@@ -70,7 +67,7 @@ def test_solution_optimality():
     ommx_instance = Instance.from_components(
         decision_variables=[x, y],
         objective=x + y,
-        constraints=[],
+        constraints={},
         sense=Instance.MAXIMIZE,
     )
 
@@ -83,7 +80,7 @@ def test_partial_evaluate():
     instance = Instance.from_components(
         decision_variables=x,
         objective=x[0] + x[1] + x[2],
-        constraints=[(x[0] + x[1] + x[2] <= 1).set_id(0)],  # one-hot constraint
+        constraints={0: x[0] + x[1] + x[2] <= 1},  # one-hot constraint
         sense=Instance.MINIMIZE,
     )
     assert instance.used_decision_variables == x
@@ -109,7 +106,7 @@ def test_relax_constraint():
     instance = Instance.from_components(
         decision_variables=x,
         objective=x[0] + x[1],
-        constraints=[(x[0] + 2 * x[1] <= 1).set_id(0), (x[1] + x[2] <= 1).set_id(1)],
+        constraints={0: x[0] + 2 * x[1] <= 1, 1: x[1] + x[2] <= 1},
         sense=Instance.MINIMIZE,
     )
 
@@ -150,7 +147,7 @@ def test_integration_timelimit():
     instance = Instance.from_components(
         decision_variables=x,
         objective=sum(v[i] * x[i] for i in range(n)),
-        constraints=[constraint],
+        constraints={0: constraint},
         sense=Instance.MAXIMIZE,
     )
     adapter = OMMXPythonMIPAdapter(instance)
@@ -172,7 +169,7 @@ def test_infeasible_problem():
     instance = Instance.from_components(
         decision_variables=[x],
         objective=x,
-        constraints=[x >= 4],
+        constraints={0: x >= 4},
         sense=Instance.MAXIMIZE,
     )
     adapter = OMMXPythonMIPAdapter(instance)
@@ -189,7 +186,7 @@ def test_unbounded_problem():
     instance = Instance.from_components(
         decision_variables=[x],
         objective=x,
-        constraints=[],
+        constraints={},
         sense=Instance.MAXIMIZE,
     )
     adapter = OMMXPythonMIPAdapter(instance)
@@ -205,7 +202,7 @@ def test_decode_before_optimize():
     instance = Instance.from_components(
         decision_variables=[x],
         objective=x,
-        constraints=[],
+        constraints={},
         sense=Instance.MINIMIZE,
     )
     adapter = OMMXPythonMIPAdapter(instance)