ommx-python-mip-adapter 3.0.0b5__tar.gz → 3.0.0b6__tar.gz

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ommx_python_mip_adapter
-Version: 3.0.0b5
+Version: 3.0.0b6
 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<4.0.0,>=3.0.0b5
+Requires-Dist: ommx<4.0.0,>=3.0.0b6
 Requires-Dist: mip<2.0.0,>=1.17.0
 Requires-Dist: cffi<2.0.0,>=1.15.0
 
@@ -67,14 +67,14 @@ Python-MIP can be used through `ommx-python-mip-adapter` by using the following:
 
 ```python markdown-code-runner
 from ommx_python_mip_adapter import OMMXPythonMIPAdapter
-from ommx import Instance, DecisionVariable
+from ommx import DecisionVariable, Instance, Sense
 
 x1 = DecisionVariable.integer(1, lower=0, upper=5)
 ommx_instance = Instance.from_components(
     decision_variables=[x1],
     objective=x1,
     constraints={},
-    sense=Instance.MINIMIZE,
+    sense=Sense.Minimize,
 )
 
 # Create `ommx.Solution` from the `mip.Model`

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/README.md

@@ -46,14 +46,14 @@ Python-MIP can be used through `ommx-python-mip-adapter` by using the following:
 
 ```python markdown-code-runner
 from ommx_python_mip_adapter import OMMXPythonMIPAdapter
-from ommx import Instance, DecisionVariable
+from ommx import DecisionVariable, Instance, Sense
 
 x1 = DecisionVariable.integer(1, lower=0, upper=5)
 ommx_instance = Instance.from_components(
     decision_variables=[x1],
     objective=x1,
     constraints={},
-    sense=Instance.MINIMIZE,
+    sense=Sense.Minimize,
 )
 
 # Create `ommx.Solution` from the `mip.Model`

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/ommx_python_mip_adapter/adapter.py

@@ -14,8 +14,6 @@ from ommx.adapter import (
     NoSolutionReturned,
 )
 from ommx import (
-    Constraint,
-    DecisionVariable,
     Equality,
     Function,
     Instance,
@@ -94,9 +92,9 @@ class OMMXPythonMIPAdapter(SolverAdapter):
         """
         with _tracer.start_as_current_span("convert"):
             self.require_applicable(ommx_instance)
-            if ommx_instance.sense == Instance.MAXIMIZE:
+            if ommx_instance.sense == Sense.Maximize:
                 sense = mip.MAXIMIZE
-            elif ommx_instance.sense == Instance.MINIMIZE:
+            elif ommx_instance.sense == Sense.Minimize:
                 sense = mip.MINIMIZE
             else:
                 raise OMMXPythonMIPAdapterError(
@@ -159,7 +157,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             ...     decision_variables=x,
             ...     objective=sum(p[i] * x[i] for i in range(6)),
             ...     constraints={0: sum(w[i] * x[i] for i in range(6)) <= 47},
-            ...     sense=Instance.MAXIMIZE,
+            ...     sense=Sense.Maximize,
             ... )
 
             Solve it
@@ -194,7 +192,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
                 ...     decision_variables=[x],
                 ...     objective=x,
                 ...     constraints={0: x >= 4},
-                ...     sense=Instance.MAXIMIZE,
+                ...     sense=Sense.Maximize,
                 ... )
 
                 >>> OMMXPythonMIPAdapter.solve(instance)
@@ -214,7 +212,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
                 ...     decision_variables=[x],
                 ...     objective=x,
                 ...     constraints={},
-                ...     sense=Instance.MAXIMIZE,
+                ...     sense=Sense.Maximize,
                 ... )
 
                 >>> OMMXPythonMIPAdapter.solve(instance)
@@ -235,7 +233,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
                 ...     decision_variables=[x, y],
                 ...     objective=x + y,
                 ...     constraints={0: x + y <= 1},
-                ...     sense=Instance.MAXIMIZE,
+                ...     sense=Sense.Maximize,
                 ... )
 
                 >>> solution = OMMXPythonMIPAdapter.solve(instance)
@@ -315,7 +313,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             ...     decision_variables=x,
             ...     objective=sum(p[i] * x[i] for i in range(6)),
             ...     constraints={0: sum(w[i] * x[i] for i in range(6)) <= 47},
-            ...     sense=Instance.MAXIMIZE,
+            ...     sense=Sense.Maximize,
             ... )
 
             >>> adapter = OMMXPythonMIPAdapter(instance)
@@ -373,7 +371,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             ...     decision_variables=[x1],
             ...     objective=x1,
             ...     constraints={},
-            ...     sense=Instance.MINIMIZE,
+            ...     sense=Sense.Minimize,
             ... )
             >>> adapter = OMMXPythonMIPAdapter(ommx_instance)
             >>> model = adapter.solver_input
@@ -416,19 +414,19 @@ class OMMXPythonMIPAdapter(SolverAdapter):
 
     def _set_decision_variables(self):
         for var in self.instance.used_decision_variables:
-            if var.kind == DecisionVariable.BINARY:
+            if var.kind == Kind.Binary:
                 self.model.add_var(
                     name=str(var.id),
                     var_type=mip.BINARY,
                 )
-            elif var.kind == DecisionVariable.INTEGER:
+            elif var.kind == Kind.Integer:
                 self.model.add_var(
                     name=str(var.id),
                     var_type=mip.INTEGER,
                     lb=var.bound.lower,  # type: ignore
                     ub=var.bound.upper,  # type: ignore
                 )
-            elif var.kind == DecisionVariable.CONTINUOUS:
+            elif var.kind == Kind.Continuous:
                 self.model.add_var(
                     name=str(var.id),
                     var_type=mip.CONTINUOUS,
@@ -477,9 +475,9 @@ class OMMXPythonMIPAdapter(SolverAdapter):
     def _set_constraints(self):
         for cid, constraint in self.instance.constraints.items():
             lin_expr = self._as_lin_expr(constraint.function)
-            if constraint.equality == Constraint.EQUAL_TO_ZERO:
+            if constraint.equality == Equality.EqualToZero:
                 constr_expr = lin_expr == 0
-            elif constraint.equality == Constraint.LESS_THAN_OR_EQUAL_TO_ZERO:
+            elif constraint.equality == Equality.LessThanOrEqualToZero:
                 constr_expr = lin_expr <= 0  # type: ignore
             else:
                 raise OMMXPythonMIPAdapterError(

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/ommx_python_mip_adapter/python_mip_to_ommx.py

@@ -4,7 +4,15 @@ from typing import final
 import mip
 
 from mip.exceptions import ParameterNotAvailable
-from ommx import Instance, DecisionVariable, Constraint, Function, Linear
+from ommx import (
+    Constraint,
+    DecisionVariable,
+    Equality,
+    Function,
+    Instance,
+    Linear,
+    Sense,
+)
 
 from .exception import OMMXPythonMIPAdapterError
 
@@ -83,13 +91,13 @@ class OMMXInstanceBuilder:
             if lin_expr.sense == "=":
                 constraint = Constraint(
                     function=self.as_ommx_function(lin_expr),
-                    equality=Constraint.EQUAL_TO_ZERO,
+                    equality=Equality.EqualToZero,
                     name=name,
                 )
             elif lin_expr.sense == "<":
                 constraint = Constraint(
                     function=self.as_ommx_function(lin_expr),
-                    equality=Constraint.LESS_THAN_OR_EQUAL_TO_ZERO,
+                    equality=Equality.LessThanOrEqualToZero,
                     name=name,
                 )
             elif lin_expr.sense == ">":
@@ -97,7 +105,7 @@ class OMMXInstanceBuilder:
                 # So multiply the linear expression by -1.
                 constraint = Constraint(
                     function=self.as_ommx_function(-lin_expr),
-                    equality=Constraint.LESS_THAN_OR_EQUAL_TO_ZERO,
+                    equality=Equality.LessThanOrEqualToZero,
                     name=name,
                 )
             else:
@@ -112,9 +120,9 @@ class OMMXInstanceBuilder:
 
     def sense(self):
         if self.model.sense == mip.MAXIMIZE:
-            return Instance.MAXIMIZE
+            return Sense.Maximize
         elif self.model.sense == mip.MINIMIZE:
-            return Instance.MINIMIZE
+            return Sense.Minimize
         raise OMMXPythonMIPAdapterError(f"Not supported sense: {self.model.sense}")
 
     @final

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/ommx_python_mip_adapter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ommx_python_mip_adapter
-Version: 3.0.0b5
+Version: 3.0.0b6
 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<4.0.0,>=3.0.0b5
+Requires-Dist: ommx<4.0.0,>=3.0.0b6
 Requires-Dist: mip<2.0.0,>=1.17.0
 Requires-Dist: cffi<2.0.0,>=1.15.0
 
@@ -67,14 +67,14 @@ Python-MIP can be used through `ommx-python-mip-adapter` by using the following:
 
 ```python markdown-code-runner
 from ommx_python_mip_adapter import OMMXPythonMIPAdapter
-from ommx import Instance, DecisionVariable
+from ommx import DecisionVariable, Instance, Sense
 
 x1 = DecisionVariable.integer(1, lower=0, upper=5)
 ommx_instance = Instance.from_components(
     decision_variables=[x1],
     objective=x1,
     constraints={},
-    sense=Instance.MINIMIZE,
+    sense=Sense.Minimize,
 )
 
 # Create `ommx.Solution` from the `mip.Model`

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/ommx_python_mip_adapter.egg-info/requires.txt

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

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ommx_python_mip_adapter"
-version = "3.0.0b5"
+version = "3.0.0b6"
 
 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 >= 3.0.0b5, < 4.0.0",
+  "ommx >= 3.0.0b6, < 4.0.0",
   "mip >= 1.17.0, < 2.0.0",
   "cffi >= 1.15.0, < 2.0.0",
 ]

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/tests/test_adapter.py

@@ -63,7 +63,7 @@ def test_error_nonlinear_objective():
         decision_variables=[x],
         objective=2.3 * x * x,
         constraints={},
-        sense=Instance.MINIMIZE,
+        sense=Sense.Minimize,
     )
 
     with pytest.raises(AdapterNotApplicableError) as e:
@@ -98,7 +98,7 @@ def test_error_nonlinear_constraint():
         decision_variables=[x],
         objective=0.0,
         constraints={0: 2.3 * x * x == 0},
-        sense=Instance.MINIMIZE,
+        sense=Sense.Minimize,
     )
 
     with pytest.raises(AdapterNotApplicableError) as e:

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/tests/test_constant_constraint.py

@@ -1,5 +1,5 @@
 from ommx_python_mip_adapter import OMMXPythonMIPAdapter
-from ommx import Instance, DecisionVariable, Linear
+from ommx import DecisionVariable, Instance, Linear, Sense
 from ommx.adapter import InfeasibleDetected
 import pytest
 
@@ -17,7 +17,7 @@ def test_constant_constraint_feasible():
             Linear(terms={}, constant=1) >= 0,
             1: x <= 1,
         },
-        sense=Instance.MAXIMIZE,
+        sense=Sense.Maximize,
     )
     solution = OMMXPythonMIPAdapter.solve(instance)
 
@@ -40,7 +40,7 @@ def test_constant_constraint_infeasible():
             Linear(terms={}, constant=-1) >= 0,
             1: x <= 1,
         },
-        sense=Instance.MAXIMIZE,
+        sense=Sense.Maximize,
     )
     with pytest.raises(InfeasibleDetected):
         OMMXPythonMIPAdapter.solve(instance)

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/tests/test_integration.py

@@ -49,7 +49,7 @@ def test_integration_milp():
         decision_variables=[x1, x2],
         objective=-x1 - x2,
         constraints={0: 3 * x1 - x2 <= 6, 1: -x1 + 3 * x2 <= 6},
-        sense=Instance.MINIMIZE,
+        sense=Sense.Minimize,
     )
 
     adapter = OMMXPythonMIPAdapter(ommx_instance)
@@ -68,7 +68,7 @@ def test_solution_optimality():
         decision_variables=[x, y],
         objective=x + y,
         constraints={},
-        sense=Instance.MAXIMIZE,
+        sense=Sense.Maximize,
     )
 
     solution = OMMXPythonMIPAdapter.solve(ommx_instance)
@@ -81,7 +81,7 @@ def test_solution_optimality_is_not_transported_through_fixed_penalty():
         decision_variables=[x],
         objective=x,
         constraints={7: x == 1},
-        sense=Instance.MINIMIZE,
+        sense=Sense.Minimize,
     )
     instance.to_qubo(uniform_penalty_weight=0.0)
 
@@ -115,7 +115,7 @@ def test_partial_evaluate():
         decision_variables=x,
         objective=x[0] + x[1] + x[2],
         constraints={0: x[0] + x[1] + x[2] <= 1},  # one-hot constraint
-        sense=Instance.MINIMIZE,
+        sense=Sense.Minimize,
     )
     assert instance.used_decision_variables == x
     partial = instance.partial_evaluate({0: 1})
@@ -141,7 +141,7 @@ def test_relax_constraint():
         decision_variables=x,
         objective=x[0] + x[1],
         constraints={0: x[0] + 2 * x[1] <= 1, 1: x[1] + x[2] <= 1},
-        sense=Instance.MINIMIZE,
+        sense=Sense.Minimize,
     )
 
     assert instance.used_decision_variables == x
@@ -182,7 +182,7 @@ def test_integration_timelimit():
         decision_variables=x,
         objective=sum(v[i] * x[i] for i in range(n)),
         constraints={0: constraint},
-        sense=Instance.MAXIMIZE,
+        sense=Sense.Maximize,
     )
     adapter = OMMXPythonMIPAdapter(instance)
     model = adapter.solver_input
@@ -204,7 +204,7 @@ def test_infeasible_problem():
         decision_variables=[x],
         objective=x,
         constraints={0: x >= 4},
-        sense=Instance.MAXIMIZE,
+        sense=Sense.Maximize,
     )
     adapter = OMMXPythonMIPAdapter(instance)
     model = adapter.solver_input
@@ -221,7 +221,7 @@ def test_unbounded_problem():
         decision_variables=[x],
         objective=x,
         constraints={},
-        sense=Instance.MAXIMIZE,
+        sense=Sense.Maximize,
     )
     adapter = OMMXPythonMIPAdapter(instance)
     model = adapter.solver_input
@@ -237,7 +237,7 @@ def test_decode_before_optimize():
         decision_variables=[x],
         objective=x,
         constraints={},
-        sense=Instance.MINIMIZE,
+        sense=Sense.Minimize,
     )
     adapter = OMMXPythonMIPAdapter(instance)
     model = adapter.solver_input

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/tests/test_model_to_instance.py

@@ -1,6 +1,6 @@
 import mip
 
-from ommx import DecisionVariable, Instance, Constraint
+from ommx import Equality, Kind, Sense
 
 from ommx_python_mip_adapter import model_to_instance
 
@@ -45,25 +45,25 @@ def test_milp():
 
     ommx_instance = model_to_instance(model)
 
-    assert ommx_instance.sense == Instance.MINIMIZE
+    assert ommx_instance.sense == Sense.Minimize
 
     # Check the decision variables
     assert len(ommx_instance.decision_variables) == 3
     decision_variables_x1 = ommx_instance.get_decision_variable_by_id(0)
     assert decision_variables_x1.id == 0
-    assert decision_variables_x1.kind == DecisionVariable.CONTINUOUS
+    assert decision_variables_x1.kind == Kind.Continuous
     assert decision_variables_x1.bound.lower == CONTINUOUS_LOWER_BOUND
     assert decision_variables_x1.bound.upper == CONTINUOUS_UPPER_BOUND
     assert decision_variables_x1.name == "1"
     decision_variables_x2 = ommx_instance.get_decision_variable_by_id(1)
     assert decision_variables_x2.id == 1
-    assert decision_variables_x2.kind == DecisionVariable.INTEGER
+    assert decision_variables_x2.kind == Kind.Integer
     assert decision_variables_x2.bound.lower == INTEGER_LOWER_BOUND
     assert decision_variables_x2.bound.upper == INTEGER_UPPER_BOUND
     assert decision_variables_x2.name == "2"
     decision_variables_x3 = ommx_instance.get_decision_variable_by_id(2)
     assert decision_variables_x3.id == 2
-    assert decision_variables_x3.kind == DecisionVariable.BINARY
+    assert decision_variables_x3.kind == Kind.Binary
     assert decision_variables_x3.bound.lower == 0
     assert decision_variables_x3.bound.upper == 1
     assert decision_variables_x3.name == "3"
@@ -81,7 +81,7 @@ def test_milp():
     assert len(ommx_instance.constraints) == 3
 
     constraint1 = ommx_instance.get_constraint_by_id(0)
-    assert constraint1.equality == Constraint.EQUAL_TO_ZERO
+    assert constraint1.equality == Equality.EqualToZero
     assert constraint1.function.degree() == 1
     assert constraint1.function.constant_term == 6
     constraint1_terms = constraint1.function.linear_terms
@@ -90,7 +90,7 @@ def test_milp():
     assert constraint1_terms[1] == -5
 
     constraint2 = ommx_instance.get_constraint_by_id(1)
-    assert constraint2.equality == Constraint.LESS_THAN_OR_EQUAL_TO_ZERO
+    assert constraint2.equality == Equality.LessThanOrEqualToZero
     assert constraint2.function.degree() == 1
     assert constraint2.function.constant_term == -9
     constraint2_terms = constraint2.function.linear_terms
@@ -99,7 +99,7 @@ def test_milp():
     assert constraint2_terms[2] == 8
 
     constraint3 = ommx_instance.get_constraint_by_id(2)
-    assert constraint3.equality == Constraint.LESS_THAN_OR_EQUAL_TO_ZERO
+    assert constraint3.equality == Equality.LessThanOrEqualToZero
     assert constraint3.function.degree() == 1
     assert constraint3.function.constant_term == -12
     constraint3_terms = constraint3.function.linear_terms
@@ -138,19 +138,19 @@ def test_no_objective_model():
 
     ommx_instance = model_to_instance(model)
 
-    assert ommx_instance.sense == Instance.MAXIMIZE
+    assert ommx_instance.sense == Sense.Maximize
 
     # Check the decision variables
     assert len(ommx_instance.decision_variables) == 2
     decision_variables_x1 = ommx_instance.get_decision_variable_by_id(0)
     assert decision_variables_x1.id == 0
-    assert decision_variables_x1.kind == DecisionVariable.CONTINUOUS
+    assert decision_variables_x1.kind == Kind.Continuous
     assert decision_variables_x1.bound.lower == LOWER_BOUND
     assert decision_variables_x1.bound.upper == UPPER_BOUND
     assert decision_variables_x1.name == "1"
     decision_variables_x2 = ommx_instance.get_decision_variable_by_id(1)
     assert decision_variables_x2.id == 1
-    assert decision_variables_x2.kind == DecisionVariable.CONTINUOUS
+    assert decision_variables_x2.kind == Kind.Continuous
     assert decision_variables_x2.bound.lower == LOWER_BOUND
     assert decision_variables_x2.bound.upper == UPPER_BOUND
     assert decision_variables_x2.name == "2"
@@ -163,7 +163,7 @@ def test_no_objective_model():
     assert len(ommx_instance.constraints) == 2
 
     constraint1 = ommx_instance.get_constraint_by_id(0)
-    assert constraint1.equality == Constraint.EQUAL_TO_ZERO
+    assert constraint1.equality == Equality.EqualToZero
     assert constraint1.function.degree() == 1
     assert constraint1.function.constant_term == -5
     constraint1_terms = constraint1.function.linear_terms
@@ -172,7 +172,7 @@ def test_no_objective_model():
     assert constraint1_terms[1] == 2
 
     constraint2 = ommx_instance.get_constraint_by_id(1)
-    assert constraint2.equality == Constraint.EQUAL_TO_ZERO
+    assert constraint2.equality == Equality.EqualToZero
     assert constraint2.function.degree() == 1
     assert constraint2.function.constant_term == -10
     constraint2_terms = constraint2.function.linear_terms

{ommx_python_mip_adapter-3.0.0b5 → ommx_python_mip_adapter-3.0.0b6}/tests/test_tracing.py

@@ -1,5 +1,5 @@
 from ommx.tracing import capture_trace
-from ommx import DecisionVariable, Instance
+from ommx import DecisionVariable, Instance, Sense
 
 from ommx_python_mip_adapter import OMMXPythonMIPAdapter
 
@@ -10,7 +10,7 @@ def test_solve_emits_convert_solve_decode_spans():
         decision_variables=x,
         objective=x[0] + x[1] + x[2],
         constraints={0: x[0] + x[1] + x[2] <= 2},
-        sense=Instance.MINIMIZE,
+        sense=Sense.Minimize,
     )
 
     with capture_trace() as result:
@@ -29,7 +29,7 @@ def test_manual_flow_emits_convert_and_decode_spans():
         decision_variables=x,
         objective=x[0] + x[1] + x[2],
         constraints={0: x[0] + x[1] + x[2] <= 2},
-        sense=Instance.MINIMIZE,
+        sense=Sense.Minimize,
     )
 
     with capture_trace() as result: