pyoframe 1.1.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

pyoframe/_arithmetic.py

@@ -431,14 +431,15 @@ def _broadcast(
         maintain_order="left" if Config.maintain_order else None,
     )
     if result.get_column(missing_dims[0]).null_count() > 0:
-        target_labels = target.data.select(target._dimensions_unsafe).unique(
+        self_labels = self.data.select(self._dimensions_unsafe).unique(
             maintain_order=Config.maintain_order
         )
         _raise_extras_error(
             self,
             target,
-            target_labels.join(self.data, how="anti", on=common_dims),
+            self_labels.join(target.data, how="anti", on=common_dims),
             swapped,
+            extras_on_right=False,
         )
     res = self._new(result, self.name)
     res._copy_flags(self)

pyoframe/_core.py

@@ -79,6 +79,8 @@ class BaseOperableBlock(BaseBlock):
         See Also:
             [`drop_extras`][pyoframe.Expression.drop_extras].
         """
+        if self._extras_strategy == ExtrasStrategy.KEEP:
+            return self
         new = self._new(self.data, name=f"{self.name}.keep_extras()")
         new._copy_flags(self)
         new._extras_strategy = ExtrasStrategy.KEEP
@@ -92,6 +94,8 @@ class BaseOperableBlock(BaseBlock):
         See Also:
             [`keep_extras`][pyoframe.Expression.keep_extras].
         """
+        if self._extras_strategy == ExtrasStrategy.DROP:
+            return self
         new = self._new(self.data, name=f"{self.name}.drop_extras()")
         new._copy_flags(self)
         new._extras_strategy = ExtrasStrategy.DROP
@@ -123,6 +127,8 @@ class BaseOperableBlock(BaseBlock):
         See Also:
             [`keep_extras`][pyoframe.Expression.keep_extras] and [`drop_extras`][pyoframe.Expression.drop_extras].
         """
+        if self._extras_strategy == ExtrasStrategy.UNSET:
+            return self
         new = self._new(self.data, name=f"{self.name}.raise_extras()")
         new._copy_flags(self)
         new._extras_strategy = ExtrasStrategy.UNSET
@@ -386,6 +392,20 @@ class BaseOperableBlock(BaseBlock):
         """
         return other + (-self.to_expr())
 
+    def __or__(self, other: Operable) -> Expression:
+        if isinstance(other, (int, float)):
+            raise PyoframeError(
+                "Cannot use '|' operator with scalars. Did you mean to use '+' instead?"
+            )
+        return self.to_expr().keep_extras() + other.to_expr().keep_extras()  # type: ignore
+
+    def __ror__(self, other: Operable) -> Expression:
+        if isinstance(other, (int, float)):
+            raise PyoframeError(
+                "Cannot use '|' operator with scalars. Did you mean to use '+' instead?"
+            )
+        return self.to_expr().keep_extras() + other.to_expr().keep_extras()  # type: ignore
+
     def __le__(self, other):
         return Constraint(self - other, ConstraintSense.LE)
 
@@ -2220,7 +2240,7 @@ class Variable(BaseOperableBlock):
     """A decision variable for an optimization model.
 
     !!! tip
-        If `lb` or `ub` are a dimensioned object (e.g. an [Expression][pyoframe.Expression]), they will automatically be [broadcasted](../../learn/concepts/addition.md#adding-expressions-with-differing-dimensions-using-over) to match the variable's dimensions.
+        If `lb` or `ub` are a dimensioned object (e.g. an [Expression][pyoframe.Expression]), they will automatically be [broadcasted](../../learn/concepts/addition.md#over) to match the variable's dimensions.
 
     Parameters:
         *indexing_sets:

pyoframe/_model.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import time
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
@@ -50,6 +51,10 @@ class Model:
             Either "min" or "max". Indicates whether it's a minimization or maximization problem.
             Typically, this parameter can be omitted (`None`) as it will automatically be
             set when the objective is set using `.minimize` or `.maximize`.
+        verbose:
+            If `True`, logging messages will be printed every time a Variable or Constraint is added to the model.
+            This is useful to discover performance bottlenecks.
+            Logging can be further configured via the [`logging` module](https://docs.python.org/3/howto/logging.html) by modifying the `pyoframe` logger.
 
     Examples:
         >>> m = pf.Model()
@@ -87,6 +92,8 @@ class Model:
         "solver_name",
         "minimize",
         "maximize",
+        "_logger",
+        "_last_log",
     ]
 
     def __init__(
@@ -98,6 +105,7 @@ class Model:
         solver_uses_variable_names: bool = False,
         print_uses_variable_names: bool = True,
         sense: ObjSense | ObjSenseValue | None = None,
+        verbose: bool = False,
     ):
         self._poi, self.solver = Model._create_poi_model(solver, solver_env)
         self.solver_name: str = self.solver.name
@@ -112,6 +120,17 @@ class Model:
         self._attr = Container(self._set_attr, self._get_attr)
         self._solver_uses_variable_names = solver_uses_variable_names
 
+        self._logger = None
+        self._last_log = None
+        if verbose:
+            import logging
+
+            self._logger = logging.getLogger("pyoframe")
+            self._logger.addHandler(logging.NullHandler())
+            self._logger.setLevel(logging.DEBUG)
+
+            self._last_log = time.time()
+
     @property
     def poi(self):
         """The underlying PyOptInterface model used to interact with the solver.
@@ -326,18 +345,6 @@ class Model:
         Raises:
             ValueError: If the objective has not been defined.
 
-        Examples:
-            >>> m = pf.Model()
-            >>> m.X = pf.Variable()
-            >>> m.objective
-            Traceback (most recent call last):
-            ...
-            ValueError: Objective is not defined.
-            >>> m.maximize = m.X
-            >>> m.objective
-            <Objective (linear) terms=1>
-            X
-
         See Also:
             [`Model.has_objective`][pyoframe.Model.has_objective]
         """
@@ -357,9 +364,11 @@ class Model:
         value._on_add_to_model(self, "objective")
 
     @property
-    def minimize(self) -> Objective | None:
+    def minimize(self) -> Objective:
         """Sets or gets the model's objective for minimization problems."""
-        if self.sense != ObjSense.MIN:
+        if self._objective is None:
+            raise ValueError("Objective is not defined.")
+        if self.sense == ObjSense.MAX:
             raise ValueError("Can't get .minimize in a maximization problem.")
         return self._objective
 
@@ -372,9 +381,11 @@ class Model:
         self.objective = value
 
     @property
-    def maximize(self) -> Objective | None:
+    def maximize(self) -> Objective:
         """Sets or gets the model's objective for maximization problems."""
-        if self.sense != ObjSense.MAX:
+        if self._objective is None:
+            raise ValueError("Objective is not defined.")
+        if self.sense == ObjSense.MIN:
             raise ValueError("Can't get .maximize in a minimization problem.")
         return self._objective
 
@@ -400,14 +411,37 @@ class Model:
                     f"Cannot create {__name} since it was already created."
                 )
 
+            log = self._logger is not None and isinstance(
+                __value, (Constraint, Variable)
+            )
+
+            if log:
+                start_time = time.time()
+
             __value._on_add_to_model(self, __name)
 
+            if log:
+                solver_time = time.time() - start_time  # type: ignore
+
             if isinstance(__value, Variable):
                 self._variables.append(__value)
                 if self._var_map is not None:
                     self._var_map.add(__value)
+                if log:
+                    type_name = "variable"
             elif isinstance(__value, Constraint):
                 self._constraints.append(__value)
+                if log:
+                    type_name = "constraint"
+
+            if log:
+                elapsed_time = time.time() - self._last_log  # type: ignore
+                self._last_log += elapsed_time  # type: ignore
+
+                self._logger.debug(  # type: ignore
+                    f"Added {type_name} '{__name}' to model ({elapsed_time:.1f}s elapsed, {solver_time:.1f}s for solver, n={len(__value)})"  # type: ignore
+                )
+
         return super().__setattr__(__name, __value)
 
     # Defining a custom __getattribute__ prevents type checkers from complaining about attribute access
@@ -532,6 +566,134 @@ class Model:
         """
         self.poi.computeIIS()
 
+    def variables_size_info(self, memory_unit: pl.SizeUnit = "b") -> pl.DataFrame:
+        """Returns a DataFrame with information about the memory usage of each variable in the model.
+
+        !!! warning "Experimental"
+            This method is experimental and may change or be removed in future versions. We're interested in your [feedback]([feedback](https://github.com/Bravos-Power/pyoframe/issues).
+
+        Parameters:
+            memory_unit:
+                The size of the memory unit to use for the memory usage information.
+                See [`polars.DataFrame.estimated_size`](https://docs.pola.rs/api/python/stable/reference/dataframe/api/polars.DataFrame.estimated_size.html).
+
+        Examples:
+            >>> m = pf.Model()
+            >>> m.X = pf.Variable()
+            >>> m.Y = pf.Variable(pf.Set(dim_x=range(100)))
+            >>> m.variables_size_info()
+            shape: (3, 5)
+            ┌───────┬───────────────┬────────────────────┬───────────────────────┬────────────────────────────┐
+            │ name  ┆ num_variables ┆ num_variables_perc ┆ pyoframe_memory_usage ┆ pyoframe_memory_usage_perc │
+            │ ---   ┆ ---           ┆ ---                ┆ ---                   ┆ ---                        │
+            │ str   ┆ i64           ┆ str                ┆ i64                   ┆ str                        │
+            ╞═══════╪═══════════════╪════════════════════╪═══════════════════════╪════════════════════════════╡
+            │ Y     ┆ 100           ┆ 99.0%              ┆ 1200                  ┆ 99.7%                      │
+            │ X     ┆ 1             ┆ 1.0%               ┆ 4                     ┆ 0.3%                       │
+            │ TOTAL ┆ 101           ┆ 100.0%             ┆ 1204                  ┆ 100.0%                     │
+            └───────┴───────────────┴────────────────────┴───────────────────────┴────────────────────────────┘
+        """
+        data = pl.DataFrame(
+            [
+                dict(name=v.name, n=len(v), mem=v.estimated_size(memory_unit))
+                for v in self.variables
+            ]
+        ).sort("n", descending=True)
+
+        total = data.sum().with_columns(name=pl.lit("TOTAL"))
+        data = pl.concat([data, total])
+
+        def format(expr: pl.Expr) -> pl.Expr:
+            return (100 * expr).round(1).cast(pl.String) + pl.lit("%")
+
+        data = data.with_columns(
+            n_per=format(pl.col("n") / total["n"].item()),
+            mem_per=format(pl.col("mem") / total["mem"].item()),
+        )
+
+        data = data.select("name", "n", "n_per", "mem", "mem_per")
+        data = data.rename(
+            {
+                "n": "num_variables",
+                "n_per": "num_variables_perc",
+                "mem": "pyoframe_memory_usage",
+                "mem_per": "pyoframe_memory_usage_perc",
+            }
+        )
+
+        return pl.DataFrame(data)
+
+    def constraints_size_info(self, memory_unit: pl.SizeUnit = "b") -> pl.DataFrame:
+        """Returns a DataFrame with information about the memory usage of each constraint in the model.
+
+        !!! warning "Experimental"
+            This method is experimental and may change or be removed in future versions. We're interested in your [feedback](https://github.com/Bravos-Power/pyoframe/issues).
+
+        Parameters:
+            memory_unit:
+                The size of the memory unit to use for the memory usage information.
+                See [`polars.DataFrame.estimated_size`](https://docs.pola.rs/api/python/stable/reference/dataframe/api/polars.DataFrame.estimated_size.html).
+
+        Examples:
+            >>> m = pf.Model()
+            >>> m.X = pf.Variable()
+            >>> m.Y = pf.Variable(pf.Set(dim_x=range(100)))
+            >>> m.c1 = m.X.over("dim_x") + m.Y <= 10
+            >>> m.c2 = m.X + m.Y.sum() <= 20
+            >>> m.constraints_size_info()
+            shape: (3, 7)
+            ┌───────┬───────────────┬──────────────┬──────────────┬──────────────┬──────────────┬──────────────┐
+            │ name  ┆ num_constrain ┆ num_constrai ┆ num_non_zero ┆ num_non_zero ┆ pyoframe_mem ┆ pyoframe_mem │
+            │ ---   ┆ ts            ┆ nts_perc     ┆ s            ┆ s_perc       ┆ ory_usage    ┆ ory_usage_pe │
+            │ str   ┆ ---           ┆ ---          ┆ ---          ┆ ---          ┆ ---          ┆ rc           │
+            │       ┆ i64           ┆ str          ┆ i64          ┆ str          ┆ i64          ┆ ---          │
+            │       ┆               ┆              ┆              ┆              ┆              ┆ str          │
+            ╞═══════╪═══════════════╪══════════════╪══════════════╪══════════════╪══════════════╪══════════════╡
+            │ c1    ┆ 100           ┆ 99.0%        ┆ 300          ┆ 74.6%        ┆ 7314         ┆ 85.6%        │
+            │ c2    ┆ 1             ┆ 1.0%         ┆ 102          ┆ 25.4%        ┆ 1228         ┆ 14.4%        │
+            │ TOTAL ┆ 101           ┆ 100.0%       ┆ 402          ┆ 100.0%       ┆ 8542         ┆ 100.0%       │
+            └───────┴───────────────┴──────────────┴──────────────┴──────────────┴──────────────┴──────────────┘
+        """
+        data = pl.DataFrame(
+            [
+                dict(
+                    name=c.name,
+                    n=len(c),
+                    non_zeros=c.lhs.data.height,
+                    mem=c.estimated_size(memory_unit),
+                )
+                for c in self.constraints
+            ]
+        ).sort("n", descending=True)
+
+        total = data.sum().with_columns(name=pl.lit("TOTAL"))
+        data = pl.concat([data, total])
+
+        def format(col: pl.Expr) -> pl.Expr:
+            return (100 * col).round(1).cast(pl.String) + pl.lit("%")
+
+        data = data.with_columns(
+            n_per=format(pl.col("n") / total["n"].item()),
+            non_zeros_per=format(pl.col("non_zeros") / total["non_zeros"].item()),
+            mem_per=format(pl.col("mem") / total["mem"].item()),
+        )
+
+        data = data.select(
+            "name", "n", "n_per", "non_zeros", "non_zeros_per", "mem", "mem_per"
+        )
+        data = data.rename(
+            {
+                "n": "num_constraints",
+                "n_per": "num_constraints_perc",
+                "non_zeros": "num_non_zeros",
+                "non_zeros_per": "num_non_zeros_perc",
+                "mem": "pyoframe_memory_usage",
+                "mem_per": "pyoframe_memory_usage_perc",
+            }
+        )
+
+        return pl.DataFrame(data)
+
     def dispose(self):
         """Disposes of the model and cleans up the solver environment.
 

pyoframe/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.1.0'
-__version_tuple__ = version_tuple = (1, 1, 0)
+__version__ = version = '1.2.1'
+__version_tuple__ = version_tuple = (1, 2, 1)
 
 __commit_id__ = commit_id = None

{pyoframe-1.1.0.dist-info → pyoframe-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyoframe
-Version: 1.1.0
+Version: 1.2.1
 Summary: Blazing fast linear program interface
 Author-email: Bravos Power <dev@bravospower.com>
 License-Expression: MIT
@@ -20,7 +20,7 @@ Requires-Dist: pyarrow
 Requires-Dist: pandas<3
 Requires-Dist: pyoptinterface==0.5.1
 Provides-Extra: highs
-Requires-Dist: highsbox<=1.12.0; extra == "highs"
+Requires-Dist: highsbox<=1.13.0; extra == "highs"
 Provides-Extra: ipopt
 Requires-Dist: pyoptinterface[nlp]; extra == "ipopt"
 Requires-Dist: llvmlite<=0.46.0; extra == "ipopt"
@@ -34,7 +34,7 @@ Requires-Dist: pre-commit==4.3.0; extra == "dev"
 Requires-Dist: gurobipy==12.0.3; extra == "dev"
 Requires-Dist: coverage==7.10.6; extra == "dev"
 Requires-Dist: ipykernel==6.30.1; extra == "dev"
-Requires-Dist: highsbox<=1.12.0; extra == "dev"
+Requires-Dist: highsbox<=1.13.0; extra == "dev"
 Requires-Dist: pyoptinterface[nlp]; extra == "dev"
 Requires-Dist: numpy; extra == "dev"
 Provides-Extra: docs

pyoframe-1.2.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+pyoframe/__init__.py,sha256=Ij-9priyKTHaGzVhMhtZlDKWz0ggAwGAS9DqB4O6zWU,886
+pyoframe/_arithmetic.py,sha256=n41QG9qlAn5rZkYUmF9EUR3B3abOUJWlJEDZ3P5jgj4,20578
+pyoframe/_constants.py,sha256=LWlry4K5w-3vVyq7CpEQ28UfM3LulbKxkO-nBlWWJzE,17847
+pyoframe/_core.py,sha256=M2WbOGrCAxPdl0W2AxC9GSCD8MnRSwBHMn9hytWiQcI,119353
+pyoframe/_model.py,sha256=T9FxSeF8b3xw9P_es0LwMGnDhI4LSAuUpELCgg0RSXA,31754
+pyoframe/_model_element.py,sha256=VVRqh2uM8HFvRFvqQmgM93jqofa-8mPwyB-qYA0YjRU,6345
+pyoframe/_monkey_patch.py,sha256=7FWMRXZIHK7mRkZfOKQ8Y724q1sPbq_EiPjlJCTfYoA,1168
+pyoframe/_objective.py,sha256=HeiP4KjlXn-IplqV-MALF26yMmh41JyHXjZhhtKJIsQ,4367
+pyoframe/_param.py,sha256=FUSfITPb-WZA-xwVcF9dCCHO2K_pky5GBWooImsSy6I,4147
+pyoframe/_utils.py,sha256=XaPZ8j9YQ-HnAuT2NLAvDCJGVzKSjUmRxARNuGWykIM,12508
+pyoframe/_version.py,sha256=vTBkgV8s9uBGLjgp067jeWVTh-Y6mBirMNSkXJot2J8,704
+pyoframe-1.2.1.dist-info/licenses/LICENSE,sha256=u_Spw4ynlwTMRZeCX-uacv_hBU547pBygiA6d2ONNV4,1074
+pyoframe-1.2.1.dist-info/METADATA,sha256=YRL5iyR8Lyi58vVNZbj5UstCFa4V2xKXMOTcCPVpF4M,4060
+pyoframe-1.2.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+pyoframe-1.2.1.dist-info/top_level.txt,sha256=10z3OOJSVLriQ0IrFLMH8CH9zByugPWolqhlHlkNjV4,9
+pyoframe-1.2.1.dist-info/RECORD,,

{pyoframe-1.1.0.dist-info → pyoframe-1.2.1.dist-info}/WHEEL

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

pyoframe-1.1.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-pyoframe/__init__.py,sha256=Ij-9priyKTHaGzVhMhtZlDKWz0ggAwGAS9DqB4O6zWU,886
-pyoframe/_arithmetic.py,sha256=VZAlZZQ7StYMRbJcfWGZ7he2Ds6b6zoY0J1GxG99UWM,20549
-pyoframe/_constants.py,sha256=LWlry4K5w-3vVyq7CpEQ28UfM3LulbKxkO-nBlWWJzE,17847
-pyoframe/_core.py,sha256=EiuAhW9M2616gjW8htJqP4FuSlUb3zfwWP1ydTsQ1Qo,118507
-pyoframe/_model.py,sha256=IcmqfJ1agNF4LzHUR-bXr-K-3NXsJGcBU6Ga55jcmik,22503
-pyoframe/_model_element.py,sha256=VVRqh2uM8HFvRFvqQmgM93jqofa-8mPwyB-qYA0YjRU,6345
-pyoframe/_monkey_patch.py,sha256=7FWMRXZIHK7mRkZfOKQ8Y724q1sPbq_EiPjlJCTfYoA,1168
-pyoframe/_objective.py,sha256=HeiP4KjlXn-IplqV-MALF26yMmh41JyHXjZhhtKJIsQ,4367
-pyoframe/_param.py,sha256=FUSfITPb-WZA-xwVcF9dCCHO2K_pky5GBWooImsSy6I,4147
-pyoframe/_utils.py,sha256=XaPZ8j9YQ-HnAuT2NLAvDCJGVzKSjUmRxARNuGWykIM,12508
-pyoframe/_version.py,sha256=ePNVzJOkxR8FY5bezqKQ_fgBRbzH1G7QTaRDHvGQRAY,704
-pyoframe-1.1.0.dist-info/licenses/LICENSE,sha256=u_Spw4ynlwTMRZeCX-uacv_hBU547pBygiA6d2ONNV4,1074
-pyoframe-1.1.0.dist-info/METADATA,sha256=cO4Wu3bBxixzFjhmkzi40kRkPbAmRiQ161L8dz0MQjo,4060
-pyoframe-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pyoframe-1.1.0.dist-info/top_level.txt,sha256=10z3OOJSVLriQ0IrFLMH8CH9zByugPWolqhlHlkNjV4,9
-pyoframe-1.1.0.dist-info/RECORD,,