ommx-python-mip-adapter 0.1.0__tar.gz → 0.1.1__tar.gz

{ommx_python_mip_adapter-0.1.0 → ommx_python_mip_adapter-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ommx_python_mip_adapter
-Version: 0.1.0
+Version: 0.1.1
 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-python-mip-adapter
@@ -17,7 +17,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE-APACHE
 License-File: LICENSE-MIT
-Requires-Dist: ommx<0.2.0,>=0.1.1
+Requires-Dist: ommx<0.3.0,>=0.2.0
 Requires-Dist: mip
 Provides-Extra: dev
 Requires-Dist: markdown-code-runner; extra == "dev"
@@ -40,19 +40,31 @@ Python-MIP as a solver in OMMX toolchain
 -----------------------------------------
 ```mermaid
 sequenceDiagram
-    participant O as Other OMMX toolchain
+    participant U as User
     participant A as Adapter
     participant P as Python-MIP
-    O->>A: ommx::Instance and Parameters for Python-MIP;
-    A->>P: Translate into Python-MIP input
+    U->>A: ommx.v1.Instance
+    A->>U: Python-MIP model
+    U->>P: Python-MIP model and Parameters for Python-MIP;
     P->>P: Solve with CBC, Gurobi, or other solvers
-    P->>A: Solution
-    A->>O: ommx:Solution
+    P->>U: Optimized model
+    U->>A: Optimized model and ommx.v1.Instance
+    A->>U: ommx:SolutionList
 ```
 
 Python-MIP as a user interface to create OMMX instance
 -------------------------------------------------------
-TBW
+```mermaid
+sequenceDiagram
+    participant U as User
+    participant A as Adapter
+    participant O as Other OMMX toolchain
+    U->>A: Python-MIP model
+    A->>U: ommx.v1.Instance
+    U->>O: ommx.v1.Instance and Parameters for other solver
+    O->>O: Solve the instance with other solver using other adapter
+    O->>U: ommx.v1.Solution
+```
 
 Usage
 ======
@@ -98,6 +110,22 @@ ommx_solutions_bytes = adapter.model_to_solution(
 
 print(SolutionList.FromString(ommx_solutions_bytes))
 ```
+You can get `ommx.v1.Instance` from a Python-MIP model as the following:
+```python markdown-code-runner
+import mip
+import ommx_python_mip_adapter as adapter
+from ommx.v1.instance_pb2 import Instance
+
+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
+model.add_constr(x1 + x2 - 6 <= 0)
+
+ommx_instance_bytes = adapter.model_to_instance(model)
+
+print(Instance.FromString(ommx_instance_bytes))
+```
 
 Reference
 ==============

{ommx_python_mip_adapter-0.1.0 → ommx_python_mip_adapter-0.1.1}/README.md

@@ -8,19 +8,31 @@ Python-MIP as a solver in OMMX toolchain
 -----------------------------------------
 ```mermaid
 sequenceDiagram
-    participant O as Other OMMX toolchain
+    participant U as User
     participant A as Adapter
     participant P as Python-MIP
-    O->>A: ommx::Instance and Parameters for Python-MIP;
-    A->>P: Translate into Python-MIP input
+    U->>A: ommx.v1.Instance
+    A->>U: Python-MIP model
+    U->>P: Python-MIP model and Parameters for Python-MIP;
     P->>P: Solve with CBC, Gurobi, or other solvers
-    P->>A: Solution
-    A->>O: ommx:Solution
+    P->>U: Optimized model
+    U->>A: Optimized model and ommx.v1.Instance
+    A->>U: ommx:SolutionList
 ```
 
 Python-MIP as a user interface to create OMMX instance
 -------------------------------------------------------
-TBW
+```mermaid
+sequenceDiagram
+    participant U as User
+    participant A as Adapter
+    participant O as Other OMMX toolchain
+    U->>A: Python-MIP model
+    A->>U: ommx.v1.Instance
+    U->>O: ommx.v1.Instance and Parameters for other solver
+    O->>O: Solve the instance with other solver using other adapter
+    O->>U: ommx.v1.Solution
+```
 
 Usage
 ======
@@ -66,6 +78,22 @@ ommx_solutions_bytes = adapter.model_to_solution(
 
 print(SolutionList.FromString(ommx_solutions_bytes))
 ```
+You can get `ommx.v1.Instance` from a Python-MIP model as the following:
+```python markdown-code-runner
+import mip
+import ommx_python_mip_adapter as adapter
+from ommx.v1.instance_pb2 import Instance
+
+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
+model.add_constr(x1 + x2 - 6 <= 0)
+
+ommx_instance_bytes = adapter.model_to_instance(model)
+
+print(Instance.FromString(ommx_instance_bytes))
+```
 
 Reference
 ==============

{ommx_python_mip_adapter-0.1.0 → ommx_python_mip_adapter-0.1.1}/ommx_python_mip_adapter/__init__.py

@@ -1,9 +1,11 @@
 from ommx_python_mip_adapter.adapter import (
     instance_to_model,
+    model_to_instance,
     model_to_solution,
 )
 
 __all__ = [
     "instance_to_model",
+    "model_to_instance",
     "model_to_solution",
 ]

{ommx_python_mip_adapter-0.1.0 → ommx_python_mip_adapter-0.1.1}/ommx_python_mip_adapter/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.0'
-__version_tuple__ = version_tuple = (0, 1, 0)
+__version__ = version = '0.1.1'
+__version_tuple__ = version_tuple = (0, 1, 1)

{ommx_python_mip_adapter-0.1.0 → ommx_python_mip_adapter-0.1.1}/ommx_python_mip_adapter/adapter.py

@@ -2,10 +2,12 @@ import typing as tp
 
 import mip
 
+from mip.exceptions import ParameterNotAvailable
 from ommx.v1.constraint_pb2 import Constraint
-from ommx.v1.decision_variables_pb2 import DecisionVariable
+from ommx.v1.decision_variables_pb2 import DecisionVariable, Bound
 from ommx.v1.function_pb2 import Function
 from ommx.v1.instance_pb2 import Instance
+from ommx.v1.linear_pb2 import Linear
 from ommx.v1.solution_pb2 import Solution, SolutionList
 
 from ommx_python_mip_adapter.exception import OMMXPythonMIPAdapterError
@@ -121,6 +123,131 @@ class PythonMIPBuilder:
         return self._model
 
 
+class OMMXInstanceBuilder:
+    def __init__(
+        self,
+        model: mip.Model,
+    ):
+        self._model = model
+
+    def _decision_variables(self) -> tp.List[DecisionVariable]:
+        decision_variables = []
+
+        for var in self._model.vars:
+            if var.var_type == mip.BINARY:
+                kind = DecisionVariable.KIND_BINARY
+            elif var.var_type == mip.INTEGER:
+                kind = DecisionVariable.KIND_INTEGER
+            elif var.var_type == mip.CONTINUOUS:
+                kind = DecisionVariable.KIND_CONTINUOUS
+            else:
+                raise OMMXPythonMIPAdapterError(
+                    f"Not supported variable type. "
+                    f"idx: {var.idx} name: {var.name}, type: {var.var_type}"
+                )
+
+            decision_variables.append(
+                DecisionVariable(
+                    id=var.idx,
+                    kind=kind,
+                    bound=Bound(lower=var.lb, upper=var.ub),
+                    description=DecisionVariable.Description(name=var.name)
+                )
+            )
+
+        return decision_variables
+    
+
+    def _make_function_from_lin_expr(
+        self,
+        lin_expr: mip.LinExpr,
+    ) -> Function:
+        terms = [
+            Linear.Term(id=var.idx, coefficient=coeff)    # type: ignore
+            for var, coeff in lin_expr.expr.items()
+        ]
+        constant: float = lin_expr.const    # type: ignore
+
+        # If the terms are empty, the function is a constant.
+        if len(terms) == 0:
+            return Function(constant=constant)
+        else:
+            return Function(
+                linear=Linear(terms=terms, constant=constant)
+            )
+
+
+    def _objective(self) -> Function:
+        # In Python-MIP, it is allowed not to set the objective function.
+        # If it isn't set, the model behaves as if the objective function is set to 0.
+        # However, an error occurs when accessing `.objective`.
+        # So if an error occurs, treat the objective function as 0.
+        try:
+            objective = self._model.objective
+        except ParameterNotAvailable:
+            return Function(constant=0)
+        
+        return self._make_function_from_lin_expr(objective)
+
+
+    def _constraints(self) -> tp.List[Constraint]:
+        constraints = []
+
+        for constr in self._model.constrs:
+            id = constr.idx
+            lin_expr = constr.expr
+            name = constr.name
+
+            if lin_expr.sense == "=":
+                constraint = Constraint(
+                    id=id,
+                    equality=Constraint.EQUALITY_EQUAL_TO_ZERO,
+                    function=self._make_function_from_lin_expr(lin_expr),
+                    description=Constraint.Description(name=name),
+                )
+            elif lin_expr.sense == "<":
+                constraint = Constraint(
+                    id=id,
+                    equality=Constraint.EQUALITY_LESS_THAN_OR_EQUAL_TO_ZERO,
+                    function=self._make_function_from_lin_expr(lin_expr),
+                    description=Constraint.Description(name=name),
+                )
+            elif lin_expr.sense == ">":
+                # `ommx.v1.Constraint` does not support `GREATER_THAN_OR_EQUAL_TO_ZERO`.
+                # So multiply the linear expression by -1.
+                constraint = Constraint(
+                    id=id,
+                    equality=Constraint.EQUALITY_LESS_THAN_OR_EQUAL_TO_ZERO,
+                    function=self._make_function_from_lin_expr(-lin_expr),
+                    description=Constraint.Description(name=name),
+                )
+            else:
+                raise OMMXPythonMIPAdapterError(
+                    f"Not supported constraint sense: "
+                    f"name: {constr.name}, sense: {lin_expr.sense}"
+                )
+            
+            constraints.append(constraint)
+
+        return constraints
+
+
+    def _sense(self):
+        if self._model.sense == mip.MAXIMIZE:
+            return Instance.SENSE_MAXIMIZE
+        else:
+            return Instance.SENSE_MINIMIZE
+
+
+    def build(self) -> bytes:
+        return Instance(
+            decision_variables=self._decision_variables(),
+            objective=self._objective(),
+            constraints=self._constraints(),
+            sense=self._sense(),
+        ).SerializeToString()
+
+
 def instance_to_model(
     ommx_instance_bytes: bytes,
     *,
@@ -185,6 +312,35 @@ def instance_to_model(
     return builder.build()
 
 
+def model_to_instance(model: mip.Model) -> bytes:
+    """
+    The function to convert Python-MIP Model to ommx.v1.Instance.
+
+    Args:
+        model (mip.Model): Python-MIP Model.
+    
+    Returns:
+        bytes: Serialized ommx.v1.Instance.
+
+    Raises:
+        OMMXPythonMIPAdapterError: If converting is not possible.
+
+    Examples:
+        >>> import mip
+        >>> import ommx_python_mip_adapter as adapter
+        >>> from ommx.v1.instance_pb2 import Instance
+        >>> 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
+        >>> constr = model.add_constr(x1 + x2 - 6 <= 0)
+        >>> ommx_instance_bytes = adapter.model_to_instance(model)
+        >>> ommx_instance = Instance.FromString(ommx_instance_bytes)
+    """
+    builder = OMMXInstanceBuilder(model)
+    return builder.build()
+
+
 def model_to_solution(
     model: mip.Model,
     ommx_instance_bytes: bytes,

{ommx_python_mip_adapter-0.1.0 → ommx_python_mip_adapter-0.1.1}/ommx_python_mip_adapter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ommx_python_mip_adapter
-Version: 0.1.0
+Version: 0.1.1
 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-python-mip-adapter
@@ -17,7 +17,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE-APACHE
 License-File: LICENSE-MIT
-Requires-Dist: ommx<0.2.0,>=0.1.1
+Requires-Dist: ommx<0.3.0,>=0.2.0
 Requires-Dist: mip
 Provides-Extra: dev
 Requires-Dist: markdown-code-runner; extra == "dev"
@@ -40,19 +40,31 @@ Python-MIP as a solver in OMMX toolchain
 -----------------------------------------
 ```mermaid
 sequenceDiagram
-    participant O as Other OMMX toolchain
+    participant U as User
     participant A as Adapter
     participant P as Python-MIP
-    O->>A: ommx::Instance and Parameters for Python-MIP;
-    A->>P: Translate into Python-MIP input
+    U->>A: ommx.v1.Instance
+    A->>U: Python-MIP model
+    U->>P: Python-MIP model and Parameters for Python-MIP;
     P->>P: Solve with CBC, Gurobi, or other solvers
-    P->>A: Solution
-    A->>O: ommx:Solution
+    P->>U: Optimized model
+    U->>A: Optimized model and ommx.v1.Instance
+    A->>U: ommx:SolutionList
 ```
 
 Python-MIP as a user interface to create OMMX instance
 -------------------------------------------------------
-TBW
+```mermaid
+sequenceDiagram
+    participant U as User
+    participant A as Adapter
+    participant O as Other OMMX toolchain
+    U->>A: Python-MIP model
+    A->>U: ommx.v1.Instance
+    U->>O: ommx.v1.Instance and Parameters for other solver
+    O->>O: Solve the instance with other solver using other adapter
+    O->>U: ommx.v1.Solution
+```
 
 Usage
 ======
@@ -98,6 +110,22 @@ ommx_solutions_bytes = adapter.model_to_solution(
 
 print(SolutionList.FromString(ommx_solutions_bytes))
 ```
+You can get `ommx.v1.Instance` from a Python-MIP model as the following:
+```python markdown-code-runner
+import mip
+import ommx_python_mip_adapter as adapter
+from ommx.v1.instance_pb2 import Instance
+
+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
+model.add_constr(x1 + x2 - 6 <= 0)
+
+ommx_instance_bytes = adapter.model_to_instance(model)
+
+print(Instance.FromString(ommx_instance_bytes))
+```
 
 Reference
 ==============

{ommx_python_mip_adapter-0.1.0 → ommx_python_mip_adapter-0.1.1}/ommx_python_mip_adapter.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ ommx_python_mip_adapter.egg-info/dependency_links.txt
 ommx_python_mip_adapter.egg-info/requires.txt
 ommx_python_mip_adapter.egg-info/top_level.txt
 tests/conftest.py
-tests/test_adapter.py
-tests/test_import.py
-tests/test_integration.py
+tests/test_instance_to_model.py
+tests/test_integration.py
+tests/test_model_to_instance.py
+tests/test_model_to_solution.py

{ommx_python_mip_adapter-0.1.0 → ommx_python_mip_adapter-0.1.1}/ommx_python_mip_adapter.egg-info/requires.txt

@@ -1,4 +1,4 @@
-ommx<0.2.0,>=0.1.1
+ommx<0.3.0,>=0.2.0
 mip
 
 [dev]

{ommx_python_mip_adapter-0.1.0 → ommx_python_mip_adapter-0.1.1}/pyproject.toml

@@ -18,7 +18,7 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
 ]
 dependencies = [
-    "ommx >= 0.1.1, < 0.2.0",
+    "ommx >= 0.2.0, < 0.3.0",
     "mip",
 ]
 

ommx_python_mip_adapter-0.1.0/tests/test_adapter.py → ommx_python_mip_adapter-0.1.1/tests/test_instance_to_model.py

@@ -1,4 +1,3 @@
-import mip
 import pytest
 
 from ommx.v1.constraint_pb2 import Constraint
@@ -7,12 +6,12 @@ from ommx.v1.function_pb2 import Function
 from ommx.v1.instance_pb2 import Instance
 from ommx.v1.linear_pb2 import Linear
 from ommx.v1.quadratic_pb2 import Quadratic
-from ommx.testing import SingleFeasibleLPGenerator, DataType
 
 import ommx_python_mip_adapter as adapter
 
 from ommx_python_mip_adapter.exception import OMMXPythonMIPAdapterError
 
+
 def test_error_invalid_instance():
     with pytest.raises(OMMXPythonMIPAdapterError) as e:
         adapter.instance_to_model(b"invalid")
@@ -126,22 +125,3 @@ def test_error_not_supported_constraint_equality():
     with pytest.raises(OMMXPythonMIPAdapterError) as e:
         adapter.instance_to_model(ommx_instance_bytes)
     assert "Not supported constraint equality" in str(e.value)
-
-
-def test_error_not_optimized_model():
-    model = mip.Model()
-
-    with pytest.raises(OMMXPythonMIPAdapterError) as e:
-        adapter.model_to_solution(model, b"")
-    assert "`model.status` must be " in str(e.value)
-
-
-def test_error_invalid_ommx_instance_bytes():
-    generator = SingleFeasibleLPGenerator(10, DataType.INT)
-    ommx_instance_bytes = generator.get_v1_instance()
-    model = adapter.instance_to_model(ommx_instance_bytes)
-    model.optimize()
-
-    with pytest.raises(OMMXPythonMIPAdapterError) as e:
-        adapter.model_to_solution(model, b"invalid")
-    assert "Invalid `ommx_instance_bytes`" in str(e.value)

ommx_python_mip_adapter-0.1.1/tests/test_model_to_instance.py

@@ -0,0 +1,206 @@
+import mip
+
+from ommx.v1.constraint_pb2 import Constraint
+from ommx.v1.decision_variables_pb2 import DecisionVariable
+from ommx.v1.instance_pb2 import Instance
+
+import ommx_python_mip_adapter as adapter
+
+
+def test_milp():
+    # Objective function: - x1 - 2x2 - 3x3
+    # Constraints:
+    #     4x1 - 5x2 - 6 = 0
+    #     -7x1 + 8x3 - 9 <= 0
+    #     -10 <= x1 <= 10    (x: continuous)
+    #     -11 <= x2 <= 11    (x: integer)
+    #     x = 0 or 1    (x: binary)
+    CONTINUOUS_LOWER_BOUND = -10
+    CONTINUOUS_UPPER_BOUND = 10
+    INTEGER_LOWER_BOUND = -11
+    INTEGER_UPPER_BOUND = 11
+
+    model = mip.Model(sense=mip.MINIMIZE)
+
+    x1 = model.add_var(
+        name="1",
+        var_type=mip.CONTINUOUS,
+        lb=CONTINUOUS_LOWER_BOUND,    # type: ignore
+        ub=CONTINUOUS_UPPER_BOUND,    # type: ignore
+    )
+    x2 = model.add_var(
+        name="2",
+        var_type=mip.INTEGER,
+        lb=INTEGER_LOWER_BOUND,    # type: ignore
+        ub=INTEGER_UPPER_BOUND,    # type: ignore
+    )
+    x3 = model.add_var(
+        name="3",
+        var_type=mip.BINARY,
+    )
+
+    model.objective = -1 * x1 - 2 * x2 - 3 * x3    # type: ignore
+
+    model.add_constr(4 * x1 - 5 * x2 + 6 == 0)    # type: ignore
+    model.add_constr(- 7 * x1 + 8 * x3 - 9 <= 0)    # type: ignore
+    model.add_constr(10 * x2 - 11 * x3 + 12 >= 0)    # type: ignore
+
+    ommx_instance_bytes = adapter.model_to_instance(model)
+    ommx_instance = Instance.FromString(ommx_instance_bytes)
+
+    assert ommx_instance.sense == Instance.SENSE_MINIMIZE
+
+    # Check the decision variables
+    assert len(ommx_instance.decision_variables) == 3
+    decision_variables_x1 = ommx_instance.decision_variables[0]
+    assert decision_variables_x1.id == 0
+    assert decision_variables_x1.kind == DecisionVariable.KIND_CONTINUOUS
+    assert decision_variables_x1.bound.lower == CONTINUOUS_LOWER_BOUND
+    assert decision_variables_x1.bound.upper == CONTINUOUS_UPPER_BOUND
+    assert decision_variables_x1.description.name == "1"
+    decision_variables_x2 = ommx_instance.decision_variables[1]
+    assert decision_variables_x2.id == 1
+    assert decision_variables_x2.kind == DecisionVariable.KIND_INTEGER
+    assert decision_variables_x2.bound.lower == INTEGER_LOWER_BOUND
+    assert decision_variables_x2.bound.upper == INTEGER_UPPER_BOUND
+    assert decision_variables_x2.description.name == "2"
+    decision_variables_x3 = ommx_instance.decision_variables[2]
+    assert decision_variables_x3.id == 2
+    assert decision_variables_x3.kind == DecisionVariable.KIND_BINARY
+    assert decision_variables_x3.bound.lower == 0
+    assert decision_variables_x3.bound.upper == 1
+    assert decision_variables_x3.description.name == "3"
+
+    # Check the objective function
+    assert ommx_instance.objective.HasField("linear")
+    objective = ommx_instance.objective.linear
+    assert objective.constant == 0
+    assert len(objective.terms) == 3
+    objective_term_x1 = objective.terms[0]
+    assert objective_term_x1.id == 0
+    assert objective_term_x1.coefficient == -1
+    objective_term_x2 = objective.terms[1]
+    assert objective_term_x2.id == 1
+    assert objective_term_x2.coefficient == -2
+    objective_term_x3 = objective.terms[2]
+    assert objective_term_x3.id == 2
+    assert objective_term_x3.coefficient == -3
+
+    # Check the constraints
+    assert len(ommx_instance.constraints) == 3
+
+    constraint1 = ommx_instance.constraints[0]
+    assert constraint1.equality == Constraint.EQUALITY_EQUAL_TO_ZERO
+    assert constraint1.function.HasField("linear")
+    assert constraint1.function.linear.constant == 6
+    assert len(constraint1.function.linear.terms) == 2
+    constraint1_term_x1 = constraint1.function.linear.terms[0]
+    assert constraint1_term_x1.id == 0
+    assert constraint1_term_x1.coefficient == 4
+    constraint1_term_x2 = constraint1.function.linear.terms[1]
+    assert constraint1_term_x2.id == 1
+    assert constraint1_term_x2.coefficient == -5
+
+    constraint2 = ommx_instance.constraints[1]
+    assert constraint2.equality == Constraint.EQUALITY_LESS_THAN_OR_EQUAL_TO_ZERO
+    assert constraint2.function.HasField("linear")
+    assert constraint2.function.linear.constant == -9
+    assert len(constraint2.function.linear.terms) == 2
+    constraint2_term_x1 = constraint2.function.linear.terms[0]
+    assert constraint2_term_x1.id == 0
+    assert constraint2_term_x1.coefficient == -7
+    constraint2_term_x3 = constraint2.function.linear.terms[1]
+    assert constraint2_term_x3.id == 2
+    assert constraint2_term_x3.coefficient == 8
+
+    constraint3 = ommx_instance.constraints[2]
+    assert constraint3.equality == Constraint.EQUALITY_LESS_THAN_OR_EQUAL_TO_ZERO
+    assert constraint3.function.HasField("linear")
+    assert constraint3.function.linear.constant == -12
+    assert len(constraint3.function.linear.terms) == 2
+    constraint3_term_x2 = constraint3.function.linear.terms[0]
+    assert constraint3_term_x2.id == 1
+    assert constraint3_term_x2.coefficient == -10
+    constraint3_term_x3 = constraint3.function.linear.terms[1]
+    assert constraint3_term_x3.id == 2
+    assert constraint3_term_x3.coefficient == 11
+
+
+def test_no_objective_model():
+    # Objective function: 0    (unspecified)
+    # Constraints:
+    #     x1 + 2x2 - 5 = 0
+    #     4x1 + 3x2 - 10 = 0
+    #     -15 <= x1 <= 15   (x: continuous)
+    #     -15 <= x2 <= 15   (x: continuous)
+    LOWER_BOUND = -15
+    UPPER_BOUND = 15
+
+    model = mip.Model(sense=mip.MAXIMIZE)
+
+    x1 = model.add_var(
+        name="1",
+        var_type=mip.CONTINUOUS,
+        lb=LOWER_BOUND,    # type: ignore
+        ub=UPPER_BOUND,    # type: ignore
+    )
+    x2 = model.add_var(
+        name="2",
+        var_type=mip.CONTINUOUS,
+        lb=LOWER_BOUND,    # type: ignore
+        ub=UPPER_BOUND,    # type: ignore
+    )
+
+    model.add_constr(1 * x1 + 2 * x2 - 5 == 0)    # type: ignore
+    model.add_constr(4 * x1 + 3 * x2 - 10 == 0)    # type: ignore
+
+    ommx_instance_bytes = adapter.model_to_instance(model)
+    ommx_instance = Instance.FromString(ommx_instance_bytes)
+
+    assert ommx_instance.sense == Instance.SENSE_MAXIMIZE
+
+    # Check the decision variables
+    assert len(ommx_instance.decision_variables) == 2
+    decision_variables_x1 = ommx_instance.decision_variables[0]
+    assert decision_variables_x1.id == 0
+    assert decision_variables_x1.kind == DecisionVariable.KIND_CONTINUOUS
+    assert decision_variables_x1.bound.lower == LOWER_BOUND
+    assert decision_variables_x1.bound.upper == UPPER_BOUND
+    assert decision_variables_x1.description.name == "1"
+    decision_variables_x2 = ommx_instance.decision_variables[1]
+    assert decision_variables_x2.id == 1
+    assert decision_variables_x2.kind == DecisionVariable.KIND_CONTINUOUS
+    assert decision_variables_x2.bound.lower == LOWER_BOUND
+    assert decision_variables_x2.bound.upper == UPPER_BOUND
+    assert decision_variables_x2.description.name == "2"
+
+    # check the objective function
+    assert ommx_instance.objective.HasField("constant")
+    assert ommx_instance.objective.constant == 0
+
+    # Check the constraints
+    assert len(ommx_instance.constraints) == 2
+
+    constraint1 = ommx_instance.constraints[0]
+    assert constraint1.equality == Constraint.EQUALITY_EQUAL_TO_ZERO
+    assert constraint1.function.HasField("linear")
+    assert constraint1.function.linear.constant == -5
+    assert len(constraint1.function.linear.terms) == 2
+    constraint1_term_x1 = constraint1.function.linear.terms[0]
+    assert constraint1_term_x1.id == 0
+    assert constraint1_term_x1.coefficient == 1
+    constraint1_term_x2 = constraint1.function.linear.terms[1]
+    assert constraint1_term_x2.id == 1
+    assert constraint1_term_x2.coefficient == 2
+
+    constraint2 = ommx_instance.constraints[1]
+    assert constraint2.equality == Constraint.EQUALITY_EQUAL_TO_ZERO
+    assert constraint2.function.HasField("linear")
+    assert constraint2.function.linear.constant == -10
+    assert len(constraint2.function.linear.terms) == 2
+    constraint2_term_x1 = constraint2.function.linear.terms[0]
+    assert constraint2_term_x1.id == 0
+    assert constraint2_term_x1.coefficient == 4
+    constraint2_term_x3 = constraint2.function.linear.terms[1]
+    assert constraint2_term_x3.id == 1
+    assert constraint2_term_x3.coefficient == 3

ommx_python_mip_adapter-0.1.1/tests/test_model_to_solution.py

@@ -0,0 +1,27 @@
+import mip
+import pytest
+
+from ommx.testing import SingleFeasibleLPGenerator, DataType
+
+import ommx_python_mip_adapter as adapter
+
+from ommx_python_mip_adapter.exception import OMMXPythonMIPAdapterError
+
+
+def test_error_not_optimized_model():
+    model = mip.Model()
+
+    with pytest.raises(OMMXPythonMIPAdapterError) as e:
+        adapter.model_to_solution(model, b"")
+    assert "`model.status` must be " in str(e.value)
+
+
+def test_error_invalid_ommx_instance_bytes():
+    generator = SingleFeasibleLPGenerator(10, DataType.INT)
+    ommx_instance_bytes = generator.get_v1_instance()
+    model = adapter.instance_to_model(ommx_instance_bytes)
+    model.optimize()
+
+    with pytest.raises(OMMXPythonMIPAdapterError) as e:
+        adapter.model_to_solution(model, b"invalid")
+    assert "Invalid `ommx_instance_bytes`" in str(e.value)

ommx_python_mip_adapter-0.1.0/tests/test_import.py

@@ -1,9 +0,0 @@
-def test_import():
-    import ommx_python_mip_adapter as adapter
-    from ommx_python_mip_adapter import instance_to_model
-    from ommx_python_mip_adapter import model_to_solution
-
-    assert adapter.instance_to_model
-    assert adapter.model_to_solution
-    assert instance_to_model
-    assert model_to_solution