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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ommx_python_mip_adapter
-Version: 3.0.0b2
+Version: 3.0.0b4
 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.0b4
 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.0b4}/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.0b4}/ommx_python_mip_adapter/adapter.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import copy
 from typing import ClassVar, Optional
 
 import mip
@@ -22,8 +23,11 @@ from ommx import (
     InstanceClass,
     InstanceClassClause,
     Kind,
+    PreparationPolicy,
     Sense,
     Solution,
+    SpecialConstraintKind,
+    SpecialConstraintPreparation,
     State,
 )
 
@@ -38,7 +42,7 @@ _LINEAR_CONSTRAINT_DEGREE_BOUNDS = {
 
 
 class OMMXPythonMIPAdapter(SolverAdapter):
-    INPUT_CLASS: ClassVar[InstanceClass | None] = InstanceClass(
+    INPUT_CLASS: ClassVar[InstanceClass] = InstanceClass(
         [
             InstanceClassClause(
                 label="python-mip-linear-mip",
@@ -50,6 +54,26 @@ 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 easy API applies a fresh
+        policy to an isolated copy; callers may instead edit and apply one
+        before invoking :meth:`solve_without_preparation`.
+        """
+        return PreparationPolicy(
+            special_constraints=SpecialConstraintPreparation.lower_special_constraints(
+                kinds={
+                    SpecialConstraintKind.Indicator,
+                    SpecialConstraintKind.OneHot,
+                    SpecialConstraintKind.Sos1,
+                }
+            )
+        )
+
     def __init__(
         self,
         ommx_instance: Instance,
@@ -109,7 +133,10 @@ class OMMXPythonMIPAdapter(SolverAdapter):
         """
         Solve the given ommx.Instance using Python-MIP, returning an ommx.Solution.
 
-        :param ommx_instance: The ommx.Instance to solve.
+        The input instance is not modified. An isolated copy is prepared with
+        the recommended Python-MIP policy before preparation-free execution.
+
+        :param ommx_instance: The ommx.Instance to prepare and solve.
         :param relax: If True, relax all integer variables to continuous variables by using the `relax` parameter in Python-MIP's `Model.optimize() <https://docs.python-mip.com/en/latest/classes.html#mip.Model.optimize>`.
         :param verbose: If True, enable Python-MIP's verbose mode
 
@@ -214,9 +241,28 @@ class OMMXPythonMIPAdapter(SolverAdapter):
                 1.0
 
         """
-        _ = diagnostics
+        prepared = copy.copy(ommx_instance)
+        prepared.prepare(cls.INPUT_CLASS, cls.recommended_preparation_policy())
+        return cls.solve_without_preparation(
+            prepared,
+            relax=relax,
+            verbose=verbose,
+            diagnostics=diagnostics,
+        )
+
+    @classmethod
+    def solve_without_preparation(
+        cls,
+        ommx_instance: Instance,
+        relax: bool = False,
+        verbose: bool = False,
+        *,
+        diagnostics: DiagnosticsSink | None = None,
+    ) -> Solution:
+        """Solve an exact Python-MIP Adapter input without preparing it."""
         with _tracer.start_as_current_span("solve") as span:
             span.set_attribute("adapter", f"{cls.__module__}.{cls.__qualname__}")
+            _ = diagnostics
             adapter = cls(ommx_instance, relax=relax, verbose=verbose)
             model = adapter.solver_input
             with _tracer.start_as_current_span("call"):
@@ -248,6 +294,10 @@ class OMMXPythonMIPAdapter(SolverAdapter):
         `solver_input`, you must set `solution.relaxation` yourself if you
         care about this value.
 
+        Backend optimality is mapped through the instance's output-objective
+        semantics. It remains unspecified when active-formulation optimality
+        does not transport to that objective.
+
         Examples
         =========
 
@@ -281,17 +331,22 @@ class OMMXPythonMIPAdapter(SolverAdapter):
             state = self.decode_to_state(data)
             solution = self.instance.evaluate(state)
 
-            dual_variables = {}
-            for constraint in data.constrs:
-                pi = constraint.pi
-                if pi is not None:
-                    id = int(constraint.name)
-                    dual_variables[id] = pi
-            for constraint_id, dual_value in dual_variables.items():
-                solution.set_dual_variable(constraint_id, dual_value)
+            # Duals certify the active formulation and need an explicit mapping
+            # before they can be attached to projected output semantics.
+            if self.instance.output_objective is None:
+                dual_variables = {}
+                for constraint in data.constrs:
+                    pi = constraint.pi
+                    if pi is not None:
+                        id = int(constraint.name)
+                        dual_variables[id] = pi
+                for constraint_id, dual_value in dual_variables.items():
+                    solution.set_dual_variable(constraint_id, dual_value)
 
             if data.status == mip.OptimizationStatus.OPTIMAL:
-                solution.optimality = Solution.OPTIMAL
+                solution.optimality = self.instance.map_active_optimality(
+                    Solution.OPTIMAL
+                )
 
             if self._relax:
                 solution.relaxation = Solution.LP_RELAXED

{ommx_python_mip_adapter-3.0.0b2 → ommx_python_mip_adapter-3.0.0b4}/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.0b4
 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.0b4
 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.0b4}/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.0b4
 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.0b4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ommx_python_mip_adapter"
-version = "3.0.0b2"
+version = "3.0.0b4"
 
 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.0b4, < 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.0b4}/tests/test_adapter.py

@@ -18,7 +18,6 @@ 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"
@@ -52,10 +51,8 @@ def test_input_class_accepts_complete_linear_mip_boundary(sense: Sense) -> None:
 
     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 == ()
+    assert report.is_member
+    assert report.matching_clauses == [(0, "python-mip-linear-mip")]
 
 
 def test_error_nonlinear_objective():
@@ -71,7 +68,7 @@ def test_error_nonlinear_objective():
     with pytest.raises(AdapterNotApplicableError) as e:
         OMMXPythonMIPAdapter(ommx_instance)
     assert isinstance(
-        e.value.report.input_membership.clause_reports[0].mismatches[0],
+        e.value.report.clause_reports[0].mismatches[0],
         InstanceClassMismatch.ObjectiveDegreeExceedsBound,
     )
 
@@ -90,7 +87,7 @@ def test_error_nonlinear_constraint():
     with pytest.raises(AdapterNotApplicableError) as e:
         OMMXPythonMIPAdapter(ommx_instance)
     assert isinstance(
-        e.value.report.input_membership.clause_reports[0].mismatches[0],
+        e.value.report.clause_reports[0].mismatches[0],
         InstanceClassMismatch.RegularConstraintDegreeExceedsBound,
     )
 
@@ -118,7 +115,7 @@ def test_rejects_used_unsupported_variable_kinds(
     with pytest.raises(AdapterNotApplicableError) as e:
         OMMXPythonMIPAdapter(instance)
 
-    mismatch = e.value.report.input_membership.clause_reports[0].mismatches[0]
+    mismatch = e.value.report.clause_reports[0].mismatches[0]
     assert isinstance(mismatch, InstanceClassMismatch.VariableKindNotAllowed)
     assert mismatch.kind == kind
     assert mismatch.variable_ids == {0}
@@ -137,14 +134,14 @@ def test_ignores_unused_unsupported_variable_kind() -> None:
     report = OMMXPythonMIPAdapter.check_applicability(instance)
     adapter = OMMXPythonMIPAdapter(instance)
 
-    assert report.is_applicable
+    assert report.is_member
     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)
+    y = DecisionVariable.continuous(1, lower=0, upper=2)
     instance = Instance.from_components(
         decision_variables=[x, y],
         objective=x + y,
@@ -165,9 +162,50 @@ def test_rejects_special_constraints_without_mutating_input() -> None:
     with pytest.raises(AdapterNotApplicableError) as e:
         OMMXPythonMIPAdapter(instance)
 
-    mismatches = e.value.report.input_membership.clause_reports[0].mismatches
+    mismatches = e.value.report.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
+
+    with pytest.raises(AdapterNotApplicableError):
+        OMMXPythonMIPAdapter.solve_without_preparation(instance)
+    assert instance.to_v2_bytes() == before
+
+    solution = OMMXPythonMIPAdapter.solve(instance)
+    assert solution.feasible
+    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 not input_class.contains(instance)
+
+    policy = OMMXPythonMIPAdapter.recommended_preparation_policy()
+    assert policy.special_constraints is not None
+    assert policy.objective 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_member

{ommx_python_mip_adapter-3.0.0b2 → ommx_python_mip_adapter-3.0.0b4}/tests/test_integration.py

@@ -1,6 +1,6 @@
 import pytest
 
-from ommx import Instance, DecisionVariable, Solution
+from ommx import DecisionVariable, Instance, Optimality, Sense, Solution
 from ommx.adapter import InfeasibleDetected, UnboundedDetected, NoSolutionReturned
 from ommx.testing import SingleFeasibleLPGenerator, DataType
 
@@ -75,6 +75,40 @@ def test_solution_optimality():
     assert solution.optimality == Solution.OPTIMAL
 
 
+def test_solution_optimality_is_not_transported_through_fixed_penalty():
+    x = DecisionVariable.binary(0)
+    instance = Instance.from_components(
+        decision_variables=[x],
+        objective=x,
+        constraints={7: x == 1},
+        sense=Instance.MINIMIZE,
+    )
+    instance.to_qubo(uniform_penalty_weight=0.0)
+
+    solution = OMMXPythonMIPAdapter.solve(instance)
+
+    assert not solution.feasible
+    assert solution.optimality == Optimality.Unspecified
+
+
+def test_output_objective_omits_active_formulation_dual_values():
+    x = DecisionVariable.continuous(0, lower=0)
+    instance = Instance.from_components(
+        decision_variables=[x],
+        objective=x,
+        constraints={0: x <= 1},
+        sense=Sense.Maximize,
+    )
+    assert instance.convert_active_objective(Sense.Minimize)
+
+    adapter = OMMXPythonMIPAdapter(instance)
+    model = adapter.solver_input
+    model.optimize()
+    solution = adapter.decode(model)
+
+    assert solution.get_dual_variable(0) is None
+
+
 def test_partial_evaluate():
     x = [DecisionVariable.binary(i, name="x", subscripts=[i]) for i in range(3)]
     instance = Instance.from_components(