flixopt 2.2.0rc2__py3-none-any.whl → 3.0.1__py3-none-any.whl

flixopt/solvers.py

@@ -2,9 +2,11 @@
 This module contains the solvers of the flixopt framework, making them available to the end user in a compact way.
 """
 
+from __future__ import annotations
+
 import logging
 from dataclasses import dataclass, field
-from typing import Any, ClassVar, Dict, Optional
+from typing import Any, ClassVar
 
 logger = logging.getLogger('flixopt')
 
@@ -14,41 +16,42 @@ class _Solver:
     """
     Abstract base class for solvers.
 
-    Attributes:
-        mip_gap (float): Solver's mip gap setting. The MIP gap describes the accepted (MILP) objective,
-            and the lower bound, which is the theoretically optimal solution (LP)
-        logfile_name (str): Filename for saving the solver log.
+    Args:
+        mip_gap: Acceptable relative optimality gap in [0.0, 1.0].
+        time_limit_seconds: Time limit in seconds.
+        extra_options: Additional solver options merged into `options`.
     """
 
     name: ClassVar[str]
     mip_gap: float
     time_limit_seconds: int
-    extra_options: Dict[str, Any] = field(default_factory=dict)
+    extra_options: dict[str, Any] = field(default_factory=dict)
 
     @property
-    def options(self) -> Dict[str, Any]:
+    def options(self) -> dict[str, Any]:
         """Return a dictionary of solver options."""
         return {key: value for key, value in {**self._options, **self.extra_options}.items() if value is not None}
 
     @property
-    def _options(self) -> Dict[str, Any]:
+    def _options(self) -> dict[str, Any]:
         """Return a dictionary of solver options, translated to the solver's API."""
         raise NotImplementedError
 
 
 class GurobiSolver(_Solver):
     """
+    Gurobi solver configuration.
+
     Args:
-        mip_gap (float): Solver's mip gap setting. The MIP gap describes the accepted (MILP) objective,
-            and the lower bound, which is the theoretically optimal solution (LP)
-        time_limit_seconds (int): Solver's time limit in seconds.
-        extra_options (str): Filename for saving the solver log.
+        mip_gap: Acceptable relative optimality gap in [0.0, 1.0]; mapped to Gurobi `MIPGap`.
+        time_limit_seconds: Time limit in seconds; mapped to Gurobi `TimeLimit`.
+        extra_options: Additional solver options merged into `options`.
     """
 
     name: ClassVar[str] = 'gurobi'
 
     @property
-    def _options(self) -> Dict[str, Any]:
+    def _options(self) -> dict[str, Any]:
         return {
             'MIPGap': self.mip_gap,
             'TimeLimit': self.time_limit_seconds,
@@ -57,19 +60,20 @@ class GurobiSolver(_Solver):
 
 class HighsSolver(_Solver):
     """
-    Args:
-        mip_gap (float): Solver's mip gap setting. The MIP gap describes the accepted (MILP) objective,
-            and the lower bound, which is the theoretically optimal solution (LP)
-        time_limit_seconds (int): Solver's time limit in seconds.
-        threads (int): Number of threads to use.
-        extra_options (str): Filename for saving the solver log.
+    HiGHS solver configuration.
+
+    Attributes:
+        mip_gap: Acceptable relative optimality gap in [0.0, 1.0]; mapped to HiGHS `mip_rel_gap`.
+        time_limit_seconds: Time limit in seconds; mapped to HiGHS `time_limit`.
+        extra_options: Additional solver options merged into `options`.
+        threads (int | None): Number of threads to use. If None, HiGHS chooses.
     """
 
-    threads: Optional[int] = None
+    threads: int | None = None
     name: ClassVar[str] = 'highs'
 
     @property
-    def _options(self) -> Dict[str, Any]:
+    def _options(self) -> dict[str, Any]:
         return {
             'mip_rel_gap': self.mip_gap,
             'time_limit': self.time_limit_seconds,