ommx-python-mip-adapter 3.0.0b2__tar.gz → 3.0.0b3__tar.gz

{ommx_python_mip_adapter-3.0.0b2 → ommx_python_mip_adapter-3.0.0b3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ommx_python_mip_adapter
-Version: 3.0.0b2
+Version: 3.0.0b3
 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.0b2
+Requires-Dist: ommx<4.0.0,>=3.0.0b3
 Requires-Dist: mip<2.0.0,>=1.17.0
 Requires-Dist: cffi<2.0.0,>=1.15.0
 
@@ -90,9 +90,9 @@ import mip
 import ommx_python_mip_adapter as adapter
 
 model = mip.Model()
-x1=model.add_var(name="1", var_type=mip.INTEGER, lb=0, ub=5)
-x2=model.add_var(name="2", var_type=mip.CONTINUOUS, lb=0, ub=5)
-model.objective = - x1 - 2 * x2
+x1 = model.add_var(name="1", var_type=mip.INTEGER, lb=0, ub=5)
+x2 = model.add_var(name="2", var_type=mip.CONTINUOUS, lb=0, ub=5)
+model.objective = -x1 - 2 * x2
 model.add_constr(x1 + x2 - 6 <= 0)
 
 ommx_instance = adapter.model_to_instance(model)

{ommx_python_mip_adapter-3.0.0b2 → ommx_python_mip_adapter-3.0.0b3}/README.md

@@ -69,9 +69,9 @@ import mip
 import ommx_python_mip_adapter as adapter
 
 model = mip.Model()
-x1=model.add_var(name="1", var_type=mip.INTEGER, lb=0, ub=5)
-x2=model.add_var(name="2", var_type=mip.CONTINUOUS, lb=0, ub=5)
-model.objective = - x1 - 2 * x2
+x1 = model.add_var(name="1", var_type=mip.INTEGER, lb=0, ub=5)
+x2 = model.add_var(name="2", var_type=mip.CONTINUOUS, lb=0, ub=5)
+model.objective = -x1 - 2 * x2
 model.add_constr(x1 + x2 - 6 <= 0)
 
 ommx_instance = adapter.model_to_instance(model)

{ommx_python_mip_adapter-3.0.0b2 → ommx_python_mip_adapter-3.0.0b3}/ommx_python_mip_adapter/adapter.py

@@ -22,8 +22,11 @@ from ommx import (
     InstanceClass,
     InstanceClassClause,
     Kind,
+    PreparationPolicy,
     Sense,
     Solution,
+    SpecialConstraintKind,
+    SpecialConstraintPreparation,
     State,
 )
 
@@ -50,6 +53,25 @@ class OMMXPythonMIPAdapter(SolverAdapter):
         ]
     )
 
+    @classmethod
+    def recommended_preparation_policy(cls) -> PreparationPolicy:
+        """Recommend lowering special constraints before using Python-MIP.
+
+        Python-MIP currently accepts only regular constraints through this
+        adapter. The recommendation therefore lowers the special-constraint
+        families currently understood by OMMX. The returned policy is fresh and
+        may be edited by the caller before :meth:`Instance.prepare` is invoked.
+        """
+        return PreparationPolicy(
+            special_constraints=SpecialConstraintPreparation.lower_special_constraints(
+                kinds={
+                    SpecialConstraintKind.Indicator,
+                    SpecialConstraintKind.OneHot,
+                    SpecialConstraintKind.Sos1,
+                }
+            )
+        )
+
     def __init__(
         self,
         ommx_instance: Instance,

{ommx_python_mip_adapter-3.0.0b2 → ommx_python_mip_adapter-3.0.0b3}/ommx_python_mip_adapter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ommx_python_mip_adapter
-Version: 3.0.0b2
+Version: 3.0.0b3
 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.0b2
+Requires-Dist: ommx<4.0.0,>=3.0.0b3
 Requires-Dist: mip<2.0.0,>=1.17.0
 Requires-Dist: cffi<2.0.0,>=1.15.0
 
@@ -90,9 +90,9 @@ import mip
 import ommx_python_mip_adapter as adapter
 
 model = mip.Model()
-x1=model.add_var(name="1", var_type=mip.INTEGER, lb=0, ub=5)
-x2=model.add_var(name="2", var_type=mip.CONTINUOUS, lb=0, ub=5)
-model.objective = - x1 - 2 * x2
+x1 = model.add_var(name="1", var_type=mip.INTEGER, lb=0, ub=5)
+x2 = model.add_var(name="2", var_type=mip.CONTINUOUS, lb=0, ub=5)
+model.objective = -x1 - 2 * x2
 model.add_constr(x1 + x2 - 6 <= 0)
 
 ommx_instance = adapter.model_to_instance(model)

{ommx_python_mip_adapter-3.0.0b2 → ommx_python_mip_adapter-3.0.0b3}/ommx_python_mip_adapter.egg-info/requires.txt

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

{ommx_python_mip_adapter-3.0.0b2 → ommx_python_mip_adapter-3.0.0b3}/pyproject.toml

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

{ommx_python_mip_adapter-3.0.0b2 → ommx_python_mip_adapter-3.0.0b3}/tests/test_adapter.py

@@ -171,3 +171,37 @@ def test_rejects_special_constraints_without_mutating_input() -> None:
     assert InstanceClassMismatch.OneHotConstraintsNotAllowed in mismatch_types
     assert InstanceClassMismatch.Sos1ConstraintsNotAllowed in mismatch_types
     assert instance.to_v2_bytes() == before
+
+
+def test_recommended_preparation_reaches_the_python_mip_input_class() -> None:
+    x = DecisionVariable.binary(0)
+    y = DecisionVariable.continuous(1, lower=0, upper=2)
+    instance = Instance.from_components(
+        decision_variables=[x, y],
+        objective=x + y,
+        constraints={},
+        sense=Sense.Minimize,
+        indicator_constraints={
+            10: IndicatorConstraint(
+                indicator_variable=x,
+                function=y - 1,
+                equality=Equality.LessThanOrEqualToZero,
+            )
+        },
+        one_hot_constraints={20: OneHotConstraint(variables=[x])},
+        sos1_constraints={30: Sos1Constraint(variables=[y])},
+    )
+    input_class = OMMXPythonMIPAdapter.INPUT_CLASS
+    assert input_class is not None
+    assert not input_class.contains(instance)
+
+    policy = OMMXPythonMIPAdapter.recommended_preparation_policy()
+    assert policy.special_constraints is not None
+    assert policy.sense is None
+    assert policy.integer_slack is None
+    assert policy.integer_encoding is None
+    assert policy.fixed_penalty is None
+
+    assert instance.prepare(input_class, policy) is None
+    assert input_class.contains(instance)
+    assert OMMXPythonMIPAdapter.check_applicability(instance).is_applicable