pyoframe 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

pyoframe/constants.py

@@ -2,7 +2,6 @@
 File containing shared constants used across the package.
 """
 
-import importlib.metadata
 import typing
 from enum import Enum
 from typing import Literal, Optional
@@ -11,8 +10,9 @@ import polars as pl
 import pyoptinterface as poi
 from packaging import version
 
-# We want to try and support multiple major versions of polars
-POLARS_VERSION = version.parse(importlib.metadata.version("polars"))
+# Constant to help split our logic depending on the polars version in use.
+# This approach is compatible with polars-lts-cpu.
+POLARS_VERSION = version.parse(pl.__version__)
 
 COEF_KEY = "__coeff"
 VAR_KEY = "__variable_id"

pyoframe/model.py

@@ -17,7 +17,7 @@ from pyoframe.constants import (
 from pyoframe.core import Constraint, Variable
 from pyoframe.model_element import ModelElement, ModelElementWithId
 from pyoframe.objective import Objective
-from pyoframe.util import Container, NamedVariableMapper, get_obj_repr
+from pyoframe.util import Container, NamedVariableMapper, for_solvers, get_obj_repr
 
 
 class Model:
@@ -264,6 +264,71 @@ class Model:
     def optimize(self):
         self.poi.optimize()
 
+    @for_solvers("gurobi")
+    def convert_to_fixed(self) -> None:
+        """
+        Turns a mixed integer program into a continuous one by fixing
+        all the integer and binary variables to their solution values.
+
+        !!! warning "Gurobi only"
+            This method only works with the Gurobi solver. Open an issue if you'd like to see support for other solvers.
+
+        Example:
+            >>> m = pf.Model(solver="gurobi")
+            >>> m.X = pf.Variable(vtype=pf.VType.BINARY, lb=0)
+            >>> m.Y = pf.Variable(vtype=pf.VType.INTEGER, lb=0)
+            >>> m.Z = pf.Variable(lb=0)
+            >>> m.my_constraint = m.X + m.Y + m.Z <= 10
+            >>> m.maximize = 3 * m.X + 2 * m.Y + m.Z
+            >>> m.optimize()
+            >>> m.X.solution, m.Y.solution, m.Z.solution
+            (1.0, 9.0, 0.0)
+            >>> m.my_constraint.dual
+            Traceback (most recent call last):
+            ...
+            polars.exceptions.ComputeError: RuntimeError: Unable to retrieve attribute 'Pi'
+            >>> m.convert_to_fixed()
+            >>> m.optimize()
+            >>> m.my_constraint.dual
+            1.0
+
+            Only works for Gurobi:
+
+            >>> m = pf.Model("max", solver="highs")
+            >>> m.convert_to_fixed()
+            Traceback (most recent call last):
+            ...
+            NotImplementedError: Method 'convert_to_fixed' is not implemented for solver 'highs'.
+        """
+        self.poi._converttofixed()
+
+    @for_solvers("gurobi", "copt")
+    def compute_IIS(self):
+        """
+        Computes the Irreducible Infeasible Set (IIS) of the model.
+
+        !!! warning "Gurobi only"
+            This method only works with the Gurobi solver. Open an issue if you'd like to see support for other solvers.
+
+        Example:
+            >>> m = pf.Model(solver="gurobi")
+            >>> m.X = pf.Variable(lb=0, ub=2)
+            >>> m.Y = pf.Variable(lb=0, ub=2)
+            >>> m.bad_constraint = m.X >= 3
+            >>> m.minimize = m.X + m.Y
+            >>> m.optimize()
+            >>> m.attr.TerminationStatus
+            <TerminationStatusCode.INFEASIBLE: 3>
+            >>> m.bad_constraint.attr.IIS
+            Traceback (most recent call last):
+            ...
+            polars.exceptions.ComputeError: RuntimeError: Unable to retrieve attribute 'IISConstr'
+            >>> m.compute_IIS()
+            >>> m.bad_constraint.attr.IIS
+            True
+        """
+        self.poi.computeIIS()
+
     def _set_param(self, name, value):
         self.poi.set_raw_parameter(name, value)
 

pyoframe/util.py

@@ -389,3 +389,22 @@ class NamedVariableMapper:
             prefix=element_name,
             to_col=self.NAME_COL,
         )
+
+
+def for_solvers(*solvers: str):
+    """
+    Decorator that limits the function to only be called when the solver is in the `only` list.
+    """
+
+    def decorator(func):
+        @wraps(func)
+        def wrapper(self, *args, **kwargs):
+            if self.solver_name not in solvers:
+                raise NotImplementedError(
+                    f"Method '{func.__name__}' is not implemented for solver '{self.solver_name}'."
+                )
+            return func(self, *args, **kwargs)
+
+        return wrapper
+
+    return decorator

{pyoframe-0.1.0.dist-info → pyoframe-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pyoframe
-Version: 0.1.0
+Version: 0.1.2
 Summary: Blazing fast linear program interface
 Author-email: Bravos Power <dev@bravospower.com>
 Project-URL: Homepage, https://bravos-power.github.io/pyoframe/
@@ -20,7 +20,7 @@ Requires-Dist: numpy
 Requires-Dist: pyarrow
 Requires-Dist: pandas
 Requires-Dist: packaging
-Requires-Dist: pyoptinterface~=0.3
+Requires-Dist: pyoptinterface~=0.4
 Provides-Extra: dev
 Requires-Dist: black[jupyter]; extra == "dev"
 Requires-Dist: bumpver; extra == "dev"

pyoframe-0.1.2.dist-info/RECORD

@@ -0,0 +1,14 @@
+pyoframe/__init__.py,sha256=nEN0OgqhevtsvxEiPbJLzwPojf3ngYAoT90M_1mc4kM,477
+pyoframe/_arithmetic.py,sha256=LvuxI4pFYuqrqus4FxcIekUwXfdEMEVWBR-1h5hF7Ac,14764
+pyoframe/constants.py,sha256=Dy1sCzykZlmkbvgsc5ckujqXPuYmsKkD3stANU0qr5Y,3784
+pyoframe/core.py,sha256=C9T0wFDAgcsFVxwnLOYqQ2j9fwnCCS_usjlGSME_qmo,62743
+pyoframe/model.py,sha256=d_WyLzdfroDYAtyXs3Ie_jo5c_CGxTX5qPT4vCVaiB8,11967
+pyoframe/model_element.py,sha256=nCfe56CRWr6bwP8irUd2bmLAEGQ-7GwOQtWeqz2WxtU,5944
+pyoframe/monkey_patch.py,sha256=9IfS14G6IPabmM9z80jzi_D4Rq0Mdx5aUCA39Yi2tgE,2044
+pyoframe/objective.py,sha256=PBWxj30QkFlsvY6ijZ6KjyKdrJARD4to0ieF6GUqaQU,3238
+pyoframe/util.py,sha256=Oyk8xh6FJHlb04X_cM4lN0UzdnKLXAMrKfyOf7IexiA,13480
+pyoframe-0.1.2.dist-info/LICENSE,sha256=dkwA40ZzT-3x6eu2a6mf_o7PNSqHbdsyaFNhLxGHNQs,1065
+pyoframe-0.1.2.dist-info/METADATA,sha256=VEtEP6xMwf3R2cbBXXPgfGRnn13qv-QjYwMY6FGR24I,3518
+pyoframe-0.1.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+pyoframe-0.1.2.dist-info/top_level.txt,sha256=10z3OOJSVLriQ0IrFLMH8CH9zByugPWolqhlHlkNjV4,9
+pyoframe-0.1.2.dist-info/RECORD,,

{pyoframe-0.1.0.dist-info → pyoframe-0.1.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pyoframe-0.1.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-pyoframe/__init__.py,sha256=nEN0OgqhevtsvxEiPbJLzwPojf3ngYAoT90M_1mc4kM,477
-pyoframe/_arithmetic.py,sha256=LvuxI4pFYuqrqus4FxcIekUwXfdEMEVWBR-1h5hF7Ac,14764
-pyoframe/constants.py,sha256=STQZufgBCS7QTmyQTK_8lINYNSDjXCxVFgF1mXoXen4,3769
-pyoframe/core.py,sha256=C9T0wFDAgcsFVxwnLOYqQ2j9fwnCCS_usjlGSME_qmo,62743
-pyoframe/model.py,sha256=_anptjuAUK2JrHhC2Hy2ouyTT9arEiQAsLO1t5SwsAs,9483
-pyoframe/model_element.py,sha256=nCfe56CRWr6bwP8irUd2bmLAEGQ-7GwOQtWeqz2WxtU,5944
-pyoframe/monkey_patch.py,sha256=9IfS14G6IPabmM9z80jzi_D4Rq0Mdx5aUCA39Yi2tgE,2044
-pyoframe/objective.py,sha256=PBWxj30QkFlsvY6ijZ6KjyKdrJARD4to0ieF6GUqaQU,3238
-pyoframe/util.py,sha256=6Z-hccQ9RT208jJ4hA8pyjSoLvym5Et7M4zcJurIkkY,12941
-pyoframe-0.1.0.dist-info/LICENSE,sha256=dkwA40ZzT-3x6eu2a6mf_o7PNSqHbdsyaFNhLxGHNQs,1065
-pyoframe-0.1.0.dist-info/METADATA,sha256=PuYGrFWwrUL9sxQrremTxbUumg9KOtKVgPds14KCyjs,3518
-pyoframe-0.1.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-pyoframe-0.1.0.dist-info/top_level.txt,sha256=10z3OOJSVLriQ0IrFLMH8CH9zByugPWolqhlHlkNjV4,9
-pyoframe-0.1.0.dist-info/RECORD,,