MIPLearn v0.3

miplearn/solvers/abstract.py

@@ -0,0 +1,70 @@
+#  MIPLearn: Extensible Framework for Learning-Enhanced Mixed-Integer Optimization
+#  Copyright (C) 2020-2022, UChicago Argonne, LLC. All rights reserved.
+#  Released under the modified BSD license. See COPYING.md for more details.
+
+from abc import ABC, abstractmethod
+from typing import Optional, Dict
+
+import numpy as np
+
+from miplearn.h5 import H5File
+
+
+class AbstractModel(ABC):
+    _supports_basis_status = False
+    _supports_sensitivity_analysis = False
+    _supports_node_count = False
+    _supports_solution_pool = False
+
+    @abstractmethod
+    def add_constrs(
+        self,
+        var_names: np.ndarray,
+        constrs_lhs: np.ndarray,
+        constrs_sense: np.ndarray,
+        constrs_rhs: np.ndarray,
+        stats: Optional[Dict] = None,
+    ) -> None:
+        pass
+
+    @abstractmethod
+    def extract_after_load(self, h5: H5File) -> None:
+        pass
+
+    @abstractmethod
+    def extract_after_lp(self, h5: H5File) -> None:
+        pass
+
+    @abstractmethod
+    def extract_after_mip(self, h5: H5File) -> None:
+        pass
+
+    @abstractmethod
+    def fix_variables(
+        self,
+        var_names: np.ndarray,
+        var_values: np.ndarray,
+        stats: Optional[Dict] = None,
+    ) -> None:
+        pass
+
+    @abstractmethod
+    def optimize(self) -> None:
+        pass
+
+    @abstractmethod
+    def relax(self) -> "AbstractModel":
+        pass
+
+    @abstractmethod
+    def set_warm_starts(
+        self,
+        var_names: np.ndarray,
+        var_values: np.ndarray,
+        stats: Optional[Dict] = None,
+    ) -> None:
+        pass
+
+    @abstractmethod
+    def write(self, filename: str) -> None:
+        pass