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

{ommx_python_mip_adapter-3.0.0b1 → 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.0b1
+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.0b1
+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.0b1 → 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.0b1 → ommx_python_mip_adapter-3.0.0b3}/ommx_python_mip_adapter/adapter.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Optional
+from typing import ClassVar, Optional
 
 import mip
 from opentelemetry import trace
@@ -12,14 +12,66 @@ from ommx.adapter import (
     UnboundedDetected,
     NoSolutionReturned,
 )
-from ommx import Instance, Constraint, DecisionVariable, Solution, State, Function
+from ommx import (
+    Constraint,
+    DecisionVariable,
+    DegreeBound,
+    Equality,
+    Function,
+    Instance,
+    InstanceClass,
+    InstanceClassClause,
+    Kind,
+    PreparationPolicy,
+    Sense,
+    Solution,
+    SpecialConstraintKind,
+    SpecialConstraintPreparation,
+    State,
+)
 
 from .exception import OMMXPythonMIPAdapterError
 
 _tracer = trace.get_tracer("ommx.adapter.python_mip")
 
+_LINEAR_CONSTRAINT_DEGREE_BOUNDS = {
+    Equality.EqualToZero: DegreeBound.at_most(1),
+    Equality.LessThanOrEqualToZero: DegreeBound.at_most(1),
+}
+
 
 class OMMXPythonMIPAdapter(SolverAdapter):
+    INPUT_CLASS: ClassVar[InstanceClass | None] = InstanceClass(
+        [
+            InstanceClassClause(
+                label="python-mip-linear-mip",
+                allowed_variable_kinds={Kind.Binary, Kind.Integer, Kind.Continuous},
+                objective_degree_bound=DegreeBound.at_most(1),
+                regular_constraint_degree_bounds=_LINEAR_CONSTRAINT_DEGREE_BOUNDS,
+                allowed_senses={Sense.Minimize, Sense.Maximize},
+            )
+        ]
+    )
+
+    @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,
@@ -37,7 +89,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
         :param verbose: If True, enable Python-MIP's verbose mode
         """
         with _tracer.start_as_current_span("convert"):
-            super().__init__(ommx_instance)
+            self.require_applicable(ommx_instance)
             if ommx_instance.sense == Instance.MAXIMIZE:
                 sense = mip.MAXIMIZE
             elif ommx_instance.sense == Instance.MINIMIZE:
@@ -141,7 +193,7 @@ class OMMXPythonMIPAdapter(SolverAdapter):
                 >>> OMMXPythonMIPAdapter.solve(instance)
                 Traceback (most recent call last):
                     ...
-                ommx.adapter.InfeasibleDetected: Model was infeasible
+                ommx.InfeasibleDetected: Model was infeasible
 
         Unbounded Problem
 

{ommx_python_mip_adapter-3.0.0b1 → 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.0b1
+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.0b1
+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.0b1 → 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.0b1
+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.0b1 → 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.0b1"
+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.0b1, < 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.0b3/tests/test_adapter.py

@@ -0,0 +1,207 @@
+import pytest
+
+from ommx import (
+    DecisionVariable,
+    DegreeBound,
+    Equality,
+    IndicatorConstraint,
+    Instance,
+    InstanceClassMismatch,
+    Kind,
+    OneHotConstraint,
+    Sense,
+    Sos1Constraint,
+)
+from ommx.adapter import AdapterNotApplicableError
+from ommx_python_mip_adapter import OMMXPythonMIPAdapter
+
+
+def test_declares_linear_mip_input_class() -> None:
+    input_class = OMMXPythonMIPAdapter.INPUT_CLASS
+    assert input_class is not None
+    [clause] = input_class.clauses
+
+    assert clause.label == "python-mip-linear-mip"
+    assert clause.allowed_variable_kinds == {
+        Kind.Binary,
+        Kind.Integer,
+        Kind.Continuous,
+    }
+    assert clause.objective_degree_bound == DegreeBound.at_most(1)
+    assert clause.regular_constraint_degree_bounds == {
+        Equality.EqualToZero: DegreeBound.at_most(1),
+        Equality.LessThanOrEqualToZero: DegreeBound.at_most(1),
+    }
+    assert clause.indicator_constraint_degree_bounds == {}
+    assert not clause.allows_one_hot
+    assert not clause.allows_sos1
+    assert clause.allowed_senses == {Sense.Minimize, Sense.Maximize}
+
+
+@pytest.mark.parametrize("sense", [Sense.Minimize, Sense.Maximize])
+def test_input_class_accepts_complete_linear_mip_boundary(sense: Sense) -> None:
+    x = DecisionVariable.binary(0)
+    y = DecisionVariable.integer(1)
+    z = DecisionVariable.continuous(2)
+    instance = Instance.from_components(
+        decision_variables=[x, y, z],
+        objective=x + y + z,
+        constraints={0: x + y == 1, 1: z <= 1},
+        sense=sense,
+    )
+
+    report = OMMXPythonMIPAdapter.check_applicability(instance)
+
+    assert report.is_applicable
+    assert report.input_membership.matching_clauses == [(0, "python-mip-linear-mip")]
+    assert report.preconditions_checked
+    assert report.precondition_violations == ()
+
+
+def test_error_nonlinear_objective():
+    # Objective function: 2.3 * x * x (variable ID should match)
+    x = DecisionVariable.continuous(0)
+    ommx_instance = Instance.from_components(
+        decision_variables=[x],
+        objective=2.3 * x * x,
+        constraints={},
+        sense=Instance.MINIMIZE,
+    )
+
+    with pytest.raises(AdapterNotApplicableError) as e:
+        OMMXPythonMIPAdapter(ommx_instance)
+    assert isinstance(
+        e.value.report.input_membership.clause_reports[0].mismatches[0],
+        InstanceClassMismatch.ObjectiveDegreeExceedsBound,
+    )
+
+
+def test_error_nonlinear_constraint():
+    # Objective function: 0
+    # Constraint: 2.3 * x * x = 0
+    x = DecisionVariable.continuous(1)
+    ommx_instance = Instance.from_components(
+        decision_variables=[x],
+        objective=0.0,
+        constraints={0: 2.3 * x * x == 0},
+        sense=Instance.MINIMIZE,
+    )
+
+    with pytest.raises(AdapterNotApplicableError) as e:
+        OMMXPythonMIPAdapter(ommx_instance)
+    assert isinstance(
+        e.value.report.input_membership.clause_reports[0].mismatches[0],
+        InstanceClassMismatch.RegularConstraintDegreeExceedsBound,
+    )
+
+
+@pytest.mark.parametrize(
+    ("variable", "kind"),
+    [
+        (DecisionVariable.semi_integer(0, lower=1, upper=3), Kind.SemiInteger),
+        (
+            DecisionVariable.semi_continuous(0, lower=1, upper=3),
+            Kind.SemiContinuous,
+        ),
+    ],
+)
+def test_rejects_used_unsupported_variable_kinds(
+    variable: DecisionVariable, kind: Kind
+) -> None:
+    instance = Instance.from_components(
+        decision_variables=[variable],
+        objective=variable,
+        constraints={},
+        sense=Sense.Minimize,
+    )
+
+    with pytest.raises(AdapterNotApplicableError) as e:
+        OMMXPythonMIPAdapter(instance)
+
+    mismatch = e.value.report.input_membership.clause_reports[0].mismatches[0]
+    assert isinstance(mismatch, InstanceClassMismatch.VariableKindNotAllowed)
+    assert mismatch.kind == kind
+    assert mismatch.variable_ids == {0}
+
+
+def test_ignores_unused_unsupported_variable_kind() -> None:
+    used = DecisionVariable.continuous(0)
+    unused = DecisionVariable.semi_integer(1, lower=1, upper=3)
+    instance = Instance.from_components(
+        decision_variables=[used, unused],
+        objective=used,
+        constraints={},
+        sense=Sense.Minimize,
+    )
+
+    report = OMMXPythonMIPAdapter.check_applicability(instance)
+    adapter = OMMXPythonMIPAdapter(instance)
+
+    assert report.is_applicable
+    assert adapter.instance is instance
+    assert [variable.name for variable in adapter.solver_input.vars] == ["0"]
+
+
+def test_rejects_special_constraints_without_mutating_input() -> None:
+    x = DecisionVariable.binary(0)
+    y = DecisionVariable.continuous(1)
+    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])},
+    )
+    before = instance.to_v2_bytes()
+
+    with pytest.raises(AdapterNotApplicableError) as e:
+        OMMXPythonMIPAdapter(instance)
+
+    mismatches = e.value.report.input_membership.clause_reports[0].mismatches
+    mismatch_types = {type(mismatch) for mismatch in mismatches}
+    assert InstanceClassMismatch.IndicatorConstraintsNotAllowed in mismatch_types
+    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

ommx_python_mip_adapter-3.0.0b1/tests/test_adapter.py

@@ -1,41 +0,0 @@
-import pytest
-from ommx import Instance, DecisionVariable
-from ommx_python_mip_adapter import OMMXPythonMIPAdapter
-from ommx_python_mip_adapter.exception import OMMXPythonMIPAdapterError
-
-
-def test_error_nonlinear_objective():
-    # Objective function: 2.3 * x * x (variable ID should match)
-    x = DecisionVariable.continuous(0)
-    ommx_instance = Instance.from_components(
-        decision_variables=[x],
-        objective=2.3 * x * x,
-        constraints={},
-        sense=Instance.MINIMIZE,
-    )
-
-    with pytest.raises(OMMXPythonMIPAdapterError) as e:
-        OMMXPythonMIPAdapter(ommx_instance)
-    assert (
-        "Function with degree 2 is not supported. Only linear (degree 1) and constant (degree 0) functions are supported."
-        in str(e.value)
-    )
-
-
-def test_error_nonlinear_constraint():
-    # Objective function: 0
-    # Constraint: 2.3 * x * x = 0
-    x = DecisionVariable.continuous(1)
-    ommx_instance = Instance.from_components(
-        decision_variables=[x],
-        objective=0.0,
-        constraints={0: 2.3 * x * x == 0},
-        sense=Instance.MINIMIZE,
-    )
-
-    with pytest.raises(OMMXPythonMIPAdapterError) as e:
-        OMMXPythonMIPAdapter(ommx_instance)
-    assert (
-        "Function with degree 2 is not supported. Only linear (degree 1) and constant (degree 0) functions are supported."
-        in str(e.value)
-    )