pyoframe 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

pyoframe/_arithmetic.py

@@ -363,16 +363,67 @@ def _add_dimension(self: "Expression", target: "Expression") -> "Expression":
 
 
 def _sum_like_terms(df: pl.DataFrame) -> pl.DataFrame:
-    """Combines terms with the same variables. Removes quadratic column if they all happen to cancel."""
+    """Combines terms with the same variables."""
     dims = [c for c in df.columns if c not in RESERVED_COL_KEYS]
     var_cols = [VAR_KEY] + ([QUAD_VAR_KEY] if QUAD_VAR_KEY in df.columns else [])
-    df = (
-        df.group_by(dims + var_cols, maintain_order=True)
-        .sum()
-        .filter(pl.col(COEF_KEY) != 0)
-    )
+    df = df.group_by(dims + var_cols, maintain_order=True).sum()
+    return df
+
+
+def _simplify_expr_df(df: pl.DataFrame) -> pl.DataFrame:
+    """
+    Removes the quadratic column and terms with a zero coefficient, when applicable.
+
+    Specifically, zero coefficient terms are always removed, except if they're the only terms in which case the expression contains a single term.
+    The quadratic column is removed if the expression is not a quadratic.
+
+    Examples:
+
+        >>> import polars as pl
+        >>> df = pl.DataFrame({ VAR_KEY: [CONST_TERM, 1], QUAD_VAR_KEY: [CONST_TERM, 1], COEF_KEY: [1.0, 0]})
+        >>> _simplify_expr_df(df)
+        shape: (1, 2)
+        ┌───────────────┬─────────┐
+        │ __variable_id ┆ __coeff │
+        │ ---           ┆ ---     │
+        │ i64           ┆ f64     │
+        ╞═══════════════╪═════════╡
+        │ 0             ┆ 1.0     │
+        └───────────────┴─────────┘
+        >>> df = pl.DataFrame({"t": [1, 1, 2, 2, 3, 3], VAR_KEY: [CONST_TERM, 1, CONST_TERM, 1, 1, 2], QUAD_VAR_KEY: [CONST_TERM, CONST_TERM, CONST_TERM, CONST_TERM, CONST_TERM, 1], COEF_KEY: [1, 0, 0, 0, 1, 0]})
+        >>> _simplify_expr_df(df)
+        shape: (3, 3)
+        ┌─────┬───────────────┬─────────┐
+        │ t   ┆ __variable_id ┆ __coeff │
+        │ --- ┆ ---           ┆ ---     │
+        │ i64 ┆ i64           ┆ i64     │
+        ╞═════╪═══════════════╪═════════╡
+        │ 1   ┆ 0             ┆ 1       │
+        │ 2   ┆ 0             ┆ 0       │
+        │ 3   ┆ 1             ┆ 1       │
+        └─────┴───────────────┴─────────┘
+    """
+    df_filtered = df.filter(pl.col(COEF_KEY) != 0)
+    if len(df_filtered) < len(df):
+        dims = [c for c in df.columns if c not in RESERVED_COL_KEYS]
+        if dims:
+            dim_values = df.select(dims).unique(maintain_order=True)
+            df = (
+                dim_values.join(df_filtered, on=dims, how="left")
+                .with_columns(pl.col(COEF_KEY).fill_null(0))
+                .fill_null(CONST_TERM)
+            )
+        else:
+            df = df_filtered
+            if df.is_empty():
+                df = pl.DataFrame(
+                    {VAR_KEY: [CONST_TERM], COEF_KEY: [0]},
+                    schema={VAR_KEY: KEY_TYPE, COEF_KEY: pl.Float64},
+                )
+
     if QUAD_VAR_KEY in df.columns and (df.get_column(QUAD_VAR_KEY) == CONST_TERM).all():
         df = df.drop(QUAD_VAR_KEY)
+
     return df
 
 

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/core.py

@@ -25,6 +25,7 @@ from pyoframe._arithmetic import (
     _add_expressions,
     _get_dimensions,
     _multiply_expressions,
+    _simplify_expr_df,
 )
 from pyoframe.constants import (
     COEF_KEY,
@@ -424,21 +425,9 @@ class Expression(ModelElement, SupportsMath, SupportPolarsMethodMixin):
                     f"Cannot create an expression with duplicate indices:\n{duplicated_data}."
                 )
 
-        super().__init__(data)
+        data = _simplify_expr_df(data)
 
-    # Might add this in later
-    # @classmethod
-    # def empty(cls, dimensions=[], type=None):
-    #     data = {COEF_KEY: [], VAR_KEY: []}
-    #     data.update({d: [] for d in dimensions})
-    #     schema = {COEF_KEY: pl.Float64, VAR_KEY: pl.UInt32}
-    #     if type is not None:
-    #         schema.update({d: t for d, t in zip(dimensions, type)})
-    #     return Expression(
-    #         pl.DataFrame(data).with_columns(
-    #             *[pl.col(c).cast(t) for c, t in schema.items()]
-    #         )
-    #     )
+        super().__init__(data)
 
     @classmethod
     def constant(cls, constant: int | float) -> "Expression":
@@ -1011,7 +1000,7 @@ class Expression(ModelElement, SupportsMath, SupportPolarsMethodMixin):
                 self,
                 size=len(self),
                 dimensions=self.shape,
-                terms=len(self.data),
+                terms=self.terms,
                 degree=2 if self.degree() == 2 else None,
             )
         if include_header and include_data:
@@ -1031,6 +1020,27 @@ class Expression(ModelElement, SupportsMath, SupportPolarsMethodMixin):
     def __str__(self) -> str:
         return self.to_str()
 
+    @property
+    def terms(self) -> int:
+        """
+        Number of terms across all subexpressions.
+
+        Expressions equal to zero count as one term.
+
+        Examples:
+            >>> import polars as pl
+            >>> m = pf.Model()
+            >>> m.v = pf.Variable({"t": [1, 2]})
+            >>> coef = pl.DataFrame({"t": [1, 2], "coef": [0, 1]})
+            >>> coef*(m.v+4)
+            <Expression size=2 dimensions={'t': 2} terms=3>
+            [1]: 0
+            [2]: 4  + v[2]
+            >>> (coef*(m.v+4)).terms
+            3
+        """
+        return len(self.data)
+
 
 @overload
 def sum(over: Union[str, Sequence[str]], expr: SupportsToExpr) -> "Expression": ...

pyoframe/model.py

@@ -39,7 +39,7 @@ class Model:
             Typically, this parameter can be omitted (`None`) as it will automatically be
             set when the objective is set using `.minimize` or `.maximize`.
 
-    Example:
+    Examples:
         >>> m = pf.Model()
         >>> m.X = pf.Variable()
         >>> m.my_constraint = m.X <= 10
@@ -273,7 +273,7 @@ class 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:
+        Examples:
             >>> 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)
@@ -310,7 +310,7 @@ class 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:
+        Examples:
             >>> m = pf.Model(solver="gurobi")
             >>> m.X = pf.Variable(lb=0, ub=2)
             >>> m.Y = pf.Variable(lb=0, ub=2)
@@ -329,6 +329,35 @@ class Model:
         """
         self.poi.computeIIS()
 
+    def dispose(self):
+        """
+        Tries to close the solver connection by deleting the model and forcing the garbage collector to run.
+
+        Once this method is called, this model is no longer usable.
+
+        This method will not work if you still have variables that reference parts of this model.
+        Unfortunately, this is a limitation from the underlying solver interface library.
+        See https://github.com/metab0t/PyOptInterface/issues/36 for context.
+
+        Examples:
+            >>> m = pf.Model()
+            >>> m.X = pf.Variable()
+            >>> m.dispose()
+            >>> m.X
+            Traceback (most recent call last):
+            ...
+            AttributeError: 'Model' object has no attribute 'X'
+        """
+        import gc
+
+        for attr in dir(self):
+            if not attr.startswith("__"):
+                try:
+                    delattr(self, attr)
+                except AttributeError:
+                    pass
+        gc.collect()
+
     def _set_param(self, name, value):
         self.poi.set_raw_parameter(name, value)
 

pyoframe/model_element.py

@@ -145,7 +145,7 @@ class SupportPolarsMethodMixin(ABC):
         """
         Filters elements by the given criteria and then drops the filtered dimensions.
 
-        Example:
+        Examples:
             >>> m = pf.Model()
             >>> m.v = pf.Variable([{"hour": ["00:00", "06:00", "12:00", "18:00"]}, {"city": ["Toronto", "Berlin", "Paris"]}])
             >>> m.v.pick(hour="06:00")

{pyoframe-0.1.1.dist-info → pyoframe-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pyoframe
-Version: 0.1.1
+Version: 0.1.3
 Summary: Blazing fast linear program interface
 Author-email: Bravos Power <dev@bravospower.com>
 Project-URL: Homepage, https://bravos-power.github.io/pyoframe/
@@ -32,6 +32,7 @@ Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: gurobipy; extra == "dev"
 Requires-Dist: highsbox; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: mkdocs-material==9.*; extra == "docs"
 Requires-Dist: mkdocstrings[python]; extra == "docs"

pyoframe-0.1.3.dist-info/RECORD

@@ -0,0 +1,14 @@
+pyoframe/__init__.py,sha256=nEN0OgqhevtsvxEiPbJLzwPojf3ngYAoT90M_1mc4kM,477
+pyoframe/_arithmetic.py,sha256=vqzMZip1kTkUUMyHohUyKJxx2nEeQIH7N57fwevLWaQ,17284
+pyoframe/constants.py,sha256=Dy1sCzykZlmkbvgsc5ckujqXPuYmsKkD3stANU0qr5Y,3784
+pyoframe/core.py,sha256=4heBn7RGOWV-Yg0OoiLr8sGBaygpTx-D-pLuC4nC0Dw,62865
+pyoframe/model.py,sha256=74kCFryUt3A6NUn2GqJufxo87Tmarhs9hqwHQhxaV7Q,12961
+pyoframe/model_element.py,sha256=RBmsE2FOct3UL2N2LZLfWYv2wL_QKqNmKmmR_pD_ERs,5945
+pyoframe/monkey_patch.py,sha256=9IfS14G6IPabmM9z80jzi_D4Rq0Mdx5aUCA39Yi2tgE,2044
+pyoframe/objective.py,sha256=PBWxj30QkFlsvY6ijZ6KjyKdrJARD4to0ieF6GUqaQU,3238
+pyoframe/util.py,sha256=Oyk8xh6FJHlb04X_cM4lN0UzdnKLXAMrKfyOf7IexiA,13480
+pyoframe-0.1.3.dist-info/LICENSE,sha256=dkwA40ZzT-3x6eu2a6mf_o7PNSqHbdsyaFNhLxGHNQs,1065
+pyoframe-0.1.3.dist-info/METADATA,sha256=bI98rXOdGDqSupJYy0MFreSmhiC_q2kTat6VrBKktb8,3558
+pyoframe-0.1.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+pyoframe-0.1.3.dist-info/top_level.txt,sha256=10z3OOJSVLriQ0IrFLMH8CH9zByugPWolqhlHlkNjV4,9
+pyoframe-0.1.3.dist-info/RECORD,,

pyoframe-0.1.1.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=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.1.dist-info/LICENSE,sha256=dkwA40ZzT-3x6eu2a6mf_o7PNSqHbdsyaFNhLxGHNQs,1065
-pyoframe-0.1.1.dist-info/METADATA,sha256=fJyV3KirCM8UBwOGNYODi_6mRxKKU7chhvuYpWob4bE,3518
-pyoframe-0.1.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-pyoframe-0.1.1.dist-info/top_level.txt,sha256=10z3OOJSVLriQ0IrFLMH8CH9zByugPWolqhlHlkNjV4,9
-pyoframe-0.1.1.dist-info/RECORD,,