pyoframe 0.0.4__py3-none-any.whl → 0.0.6__py3-none-any.whl

pyoframe/__init__.py

@@ -4,12 +4,21 @@ Also applies the monkey patch to the DataFrame libraries.
 """
 
 from pyoframe.monkey_patch import patch_dataframe_libraries
-from pyoframe.constraints import sum, sum_by, Set, Constraint
+from pyoframe.core import sum, sum_by, Set, Constraint, Expression, Variable
 from pyoframe.constants import Config
-from pyoframe.variables import Variable
 from pyoframe.model import Model
 from pyoframe.constants import VType
 
 patch_dataframe_libraries()
 
-__all__ = ["sum", "sum_by", "Variable", "Model", "Set", "VType", "Config", "Constraint"]
+__all__ = [
+    "sum",
+    "sum_by",
+    "Variable",
+    "Model",
+    "Set",
+    "VType",
+    "Config",
+    "Constraint",
+    "Expression",
+]

pyoframe/_arithmetic.py

@@ -7,14 +7,11 @@ from pyoframe.constants import (
     VAR_KEY,
     UnmatchedStrategy,
     Config,
+    PyoframeError,
 )
 
 if TYPE_CHECKING:  # pragma: no cover
-    from pyoframe.constraints import Expression
-
-
-class PyoframeError(Exception):
-    pass
+    from pyoframe.core import Expression
 
 
 def _add_expressions(*expressions: "Expression") -> "Expression":
@@ -109,7 +106,7 @@ def _add_expressions_core(*expressions: "Expression") -> "Expression":
 
         strat = (left.unmatched_strategy, right.unmatched_strategy)
 
-        propogate_strat = propogatation_strategies[strat]
+        propogate_strat = propogatation_strategies[strat]  # type: ignore
 
         if strat == (UnmatchedStrategy.DROP, UnmatchedStrategy.DROP):
             left_data = left.data.join(get_indices(right), how="inner", on=dims)

pyoframe/constants.py

@@ -9,7 +9,7 @@ MIT License
 from dataclasses import dataclass
 from enum import Enum
 import typing
-from typing import Any, Literal, Optional, Union
+from typing import Literal, Optional, Union
 import polars as pl
 
 
@@ -18,7 +18,8 @@ VAR_KEY = "__variable_id"
 CONSTRAINT_KEY = "__constraint_id"
 SOLUTION_KEY = "solution"
 DUAL_KEY = "dual"
-NAME_COL = "__name"
+RC_COL = "RC"
+SLACK_COL = "slack"
 
 CONST_TERM = 0
 
@@ -28,7 +29,8 @@ RESERVED_COL_KEYS = (
     CONSTRAINT_KEY,
     SOLUTION_KEY,
     DUAL_KEY,
-    NAME_COL,
+    RC_COL,
+    SLACK_COL,
 )
 
 
@@ -48,6 +50,9 @@ class Config(metaclass=_ConfigMeta):
     disable_unmatched_checks: bool = False
     print_float_precision: Optional[int] = 5
     print_uses_variable_names: bool = True
+    # Number of elements to show when printing a set to the console (additional elements are replaced with ...)
+    print_max_set_elements: int = 50
+    enable_is_duplicated_expression_safety_check: bool = False
 
     @classmethod
     def reset_defaults(cls):
@@ -65,8 +70,8 @@ class ConstraintSense(Enum):
 
 
 class ObjSense(Enum):
-    MIN = "minimize"
-    MAX = "maximize"
+    MIN = "min"
+    MAX = "max"
 
 
 class VType(Enum):
@@ -83,7 +88,7 @@ class UnmatchedStrategy(Enum):
 
 # This is a hack to get the Literal type for VType
 # See: https://stackoverflow.com/questions/67292470/type-hinting-enum-member-value-in-python
-ObjSenseValue = Literal["minimize", "maximize"]
+ObjSenseValue = Literal["min", "max"]
 VTypeValue = Literal["continuous", "binary", "integer"]
 for enum, type in [(ObjSense, ObjSenseValue), (VType, VTypeValue)]:
     assert set(typing.get_args(type)) == {vtype.value for vtype in enum}
@@ -127,8 +132,11 @@ class SolverStatus(Enum):
     def from_termination_condition(
         cls, termination_condition: "TerminationCondition"
     ) -> "SolverStatus":
-        for status in STATUS_TO_TERMINATION_CONDITION_MAP:
-            if termination_condition in STATUS_TO_TERMINATION_CONDITION_MAP[status]:
+        for (
+            status,
+            termination_conditions,
+        ) in STATUS_TO_TERMINATION_CONDITION_MAP.items():
+            if termination_condition in termination_conditions:
                 return status
         return cls("unknown")
 
@@ -248,13 +256,8 @@ class Result:
 
     status: Status
     solution: Optional[Solution] = None
-    solver_model: Optional[Any] = None
 
     def __repr__(self) -> str:
-        solver_model_string = (
-            "not available" if self.solver_model is None else "available"
-        )
-
         res = (
             f"Status: {self.status.status.value}\n"
             f"Termination condition: {self.status.termination_condition.value}\n"
@@ -264,7 +267,6 @@ class Result:
                 f"Solution: {len(self.solution.primal)} primals, {len(self.solution.dual) if self.solution.dual is not None else 0} duals\n"
                 f"Objective: {self.solution.objective:.2e}\n"
             )
-        res += f"Solver model: {solver_model_string}\n"
 
         return res
 
@@ -278,3 +280,7 @@ class Result:
                 print(f" Optimization successful: \n{self}\n")
         else:
             print(f"Optimization failed: \n{self}\n")
+
+
+class PyoframeError(Exception):
+    pass