refactor (computations): add docstrings, __all__ and change author, delete priority system

Author: siwreienta

src/pysatl_core/distributions/computations/__init__.py

@@ -1,72 +1,43 @@
+"""
+Computations subpackage.
+
+Provides descriptor abstractions, fitter/evaluator implementations,
+helper utilities, and a registry for matching fitter descriptors
+to distribution characteristics.
+"""
+
 from __future__ import annotations
 
-__author__ = "Leonid Elkin, Mikhail Mikhailov, Irina Sergeeva"
+__author__ = "Irina Sergeeva"
 __copyright__ = "Copyright (c) 2025 PySATL project"
 __license__ = "SPDX-License-Identifier: MIT"
 
-from pysatl_core.distributions.computations.base import (
-    ComputationOption,
-    EvaluatorDescriptor,
-    FitterDescriptor,
-)
-from pysatl_core.distributions.computations.continuous import (
-    FITTER_CDF_TO_PDF_1C,
-    FITTER_CDF_TO_PPF_1C,
-    FITTER_PDF_TO_CDF_1C,
-    FITTER_PPF_TO_CDF_1C,
-    fit_cdf_to_pdf_1C,
-    fit_cdf_to_ppf_1C,
-    fit_pdf_to_cdf_1C,
-    fit_ppf_to_cdf_1C,
-)
-from pysatl_core.distributions.computations.discrete import (
-    FITTER_CDF_TO_PMF_1D,
-    FITTER_CDF_TO_PPF_1D,
-    FITTER_PMF_TO_CDF_1D,
-    FITTER_PPF_TO_CDF_1D,
-    fit_cdf_to_pmf_1D,
-    fit_cdf_to_ppf_1D,
-    fit_pmf_to_cdf_1D,
-    fit_ppf_to_cdf_1D,
-)
-from pysatl_core.distributions.computations.registry import FitterRegistry
+from .base import *
+from .base import __all__ as _base_all
+from .continuous import *
+from .continuous import __all__ as _continuous_all
+from .discrete import *
+from .discrete import __all__ as _discrete_all
+from .registry import *
+from .registry import __all__ as _registry_all
 
-ALL_FITTER_DESCRIPTORS: list[FitterDescriptor] = [
-    FITTER_PDF_TO_CDF_1C,
-    FITTER_CDF_TO_PDF_1C,
-    FITTER_CDF_TO_PPF_1C,
-    FITTER_PPF_TO_CDF_1C,
-    FITTER_PMF_TO_CDF_1D,
-    FITTER_CDF_TO_PMF_1D,
-    FITTER_CDF_TO_PPF_1D,
-    FITTER_PPF_TO_CDF_1D,
+ALL_FITTER_DESCRIPTORS: list[FitterDescriptor] = [  # noqa: F405
+    FITTER_PDF_TO_CDF_1C,  # noqa: F405
+    FITTER_CDF_TO_PDF_1C,  # noqa: F405
+    FITTER_CDF_TO_PPF_1C,  # noqa: F405
+    FITTER_PPF_TO_CDF_1C,  # noqa: F405
+    FITTER_PMF_TO_CDF_1D,  # noqa: F405
+    FITTER_CDF_TO_PMF_1D,  # noqa: F405
+    FITTER_CDF_TO_PPF_1D,  # noqa: F405
+    FITTER_PPF_TO_CDF_1D,  # noqa: F405
 ]
 
 __all__ = [
-    # Abstractions
-    "ComputationOption",
-    "FitterDescriptor",
-    "EvaluatorDescriptor",
-    "FitterRegistry",
-    # Continuous fitters
-    "fit_pdf_to_cdf_1C",
-    "fit_cdf_to_pdf_1C",
-    "fit_cdf_to_ppf_1C",
-    "fit_ppf_to_cdf_1C",
-    # Discrete fitters
-    "fit_pmf_to_cdf_1D",
-    "fit_cdf_to_pmf_1D",
-    "fit_cdf_to_ppf_1D",
-    "fit_ppf_to_cdf_1D",
-    # Descriptors
-    "FITTER_PDF_TO_CDF_1C",
-    "FITTER_CDF_TO_PDF_1C",
-    "FITTER_CDF_TO_PPF_1C",
-    "FITTER_PPF_TO_CDF_1C",
-    "FITTER_PMF_TO_CDF_1D",
-    "FITTER_CDF_TO_PMF_1D",
-    "FITTER_CDF_TO_PPF_1D",
-    "FITTER_PPF_TO_CDF_1D",
-    # Aggregate
+    *_base_all,
+    *_continuous_all,
+    *_discrete_all,
+    *_registry_all,
     "ALL_FITTER_DESCRIPTORS",
 ]
+
+del _base_all, _continuous_all, _discrete_all, _registry_all

src/pysatl_core/distributions/computations/base.py

@@ -7,7 +7,7 @@
 
 from __future__ import annotations
 
-__author__ = "Leonid Elkin, Mikhail Mikhailov, Irina Sergeeva"
+__author__ = "Irina Sergeeva"
 __copyright__ = "Copyright (c) 2025 PySATL project"
 __license__ = "SPDX-License-Identifier: MIT"
 
@@ -110,8 +110,6 @@ class FitterDescriptor:
         Structured option schema.
     constraint_tags : frozenset[str]
         Constraint tags used for matching (e.g. ``{"continuous", "univariate"}``).
-    priority : int
-        Higher priority wins when multiple fitters match.  Default is 0.
     description : str
         Human-readable summary of what the fitter does.
     """
@@ -122,7 +120,6 @@ class FitterDescriptor:
     fitter: FitterFunc
     options: tuple[ComputationOption, ...] = ()
     constraint_tags: frozenset[str] = field(default_factory=frozenset)
-    priority: int = 0
     description: str = ""
 
     def to_computation_method(self) -> FitterMethod:
@@ -193,8 +190,6 @@ class EvaluatorDescriptor:
         Structured option schema.
     constraint_tags : frozenset[str]
         Constraint tags used for matching.
-    priority : int
-        Higher priority wins when multiple evaluators match.  Default is 0.
     description : str
         Human-readable summary of what the evaluator does.
     """
@@ -205,7 +200,6 @@ class EvaluatorDescriptor:
     evaluator: EvaluatorFunc
     options: tuple[ComputationOption, ...] = ()
     constraint_tags: frozenset[str] = field(default_factory=frozenset)
-    priority: int = 0
     description: str = ""
 
     def to_computation_method(self) -> EvaluatorMethod:
@@ -251,3 +245,10 @@ def option_names(self) -> tuple[str, ...]:
     def option_defaults(self) -> dict[str, Any]:
         """Return ``{name: default}`` for every declared option."""
         return {opt.name: opt.default for opt in self.options}
+
+
+__all__ = [
+    "ComputationOption",
+    "FitterDescriptor",
+    "EvaluatorDescriptor",
+]

src/pysatl_core/distributions/computations/computation.py

@@ -11,7 +11,7 @@
 
 from __future__ import annotations
 
-__author__ = "Leonid Elkin, Mikhail Mikhailov, Irina Sergeeva"
+__author__ = "Irina Sergeeva"
 __copyright__ = "Copyright (c) 2025 PySATL project"
 __license__ = "SPDX-License-Identifier: MIT"
 
@@ -193,3 +193,11 @@ def _bound(*args: Any, **kwargs: Any) -> NumericArray:
 
 type ComputationMethodUnion = FitterMethod | EvaluatorMethod
 """Union type for computation methods (fitter or evaluator)."""
+
+
+__all__ = [
+    "FittedComputationMethod",
+    "FitterMethod",
+    "EvaluatorMethod",
+    "ComputationMethodUnion",
+]

src/pysatl_core/distributions/computations/continuous.py

@@ -1,6 +1,13 @@
+"""
+Continuous-distribution fitters (1C).
+
+Provides fitter functions and their descriptors for converting between
+continuous distribution characteristics (PDF, CDF, PPF).
+"""
+
 from __future__ import annotations
 
-__author__ = "Leonid Elkin, Mikhail Mikhailov, Irina Sergeeva"
+__author__ = "Irina Sergeeva"
 __copyright__ = "Copyright (c) 2025 PySATL project"
 __license__ = "SPDX-License-Identifier: MIT"
 
@@ -103,7 +110,6 @@ def _pdf_scalar(t: float) -> float:
         ),
     ),
     constraint_tags=frozenset({"continuous", "univariate"}),
-    priority=0,
     description="PDF -> CDF via segment-wise scipy.integrate.quad with cumsum.",
 )
 
@@ -167,7 +173,6 @@ def _pdf(x: NumericArray, **options: Any) -> NumericArray:
         ),
     ),
     constraint_tags=frozenset({"continuous", "univariate"}),
-    priority=0,
     description="CDF -> PDF via five-point central finite difference.",
 )
 
@@ -270,7 +275,6 @@ def _ppf(q: NumericArray, **options: Any) -> NumericArray:
         ),
     ),
     constraint_tags=frozenset({"continuous", "univariate"}),
-    priority=0,
     description="CDF -> PPF via vectorised bisection with exponential bound search.",
 )
 
@@ -367,6 +371,17 @@ def f(q: float) -> float:
         ),
     ),
     constraint_tags=frozenset({"continuous", "univariate"}),
-    priority=0,
     description="PPF -> CDF via root inversion (scipy.optimize.brentq).",
 )
+
+
+__all__ = [
+    "fit_pdf_to_cdf_1C",
+    "FITTER_PDF_TO_CDF_1C",
+    "fit_cdf_to_pdf_1C",
+    "FITTER_CDF_TO_PDF_1C",
+    "fit_cdf_to_ppf_1C",
+    "FITTER_CDF_TO_PPF_1C",
+    "fit_ppf_to_cdf_1C",
+    "FITTER_PPF_TO_CDF_1C",
+]

src/pysatl_core/distributions/computations/discrete.py

@@ -1,6 +1,13 @@
+"""
+Discrete-distribution fitters (1D).
+
+Provides fitter functions and their descriptors for converting between
+discrete distribution characteristics (PMF, CDF, PPF).
+"""
+
 from __future__ import annotations
 
-__author__ = "Leonid Elkin, Mikhail Mikhailov, Irina Sergeeva"
+__author__ = "Irina Sergeeva"
 __copyright__ = "Copyright (c) 2025 PySATL project"
 __license__ = "SPDX-License-Identifier: MIT"
 
@@ -112,7 +119,6 @@ def _cdf(x: NumericArray, **options: Any) -> NumericArray:
     fitter=fit_pmf_to_cdf_1D,
     options=(),
     constraint_tags=frozenset({"discrete", "univariate"}),
-    priority=0,
     description="PMF -> CDF via prefix-sum (finite support) or tail summation (left-unbounded).",
 )
 
@@ -182,7 +188,6 @@ def _pmf(x: NumericArray, **options: Any) -> NumericArray:
     fitter=fit_cdf_to_pmf_1D,
     options=(),
     constraint_tags=frozenset({"discrete", "univariate"}),
-    priority=0,
     description="CDF -> PMF via finite differences on the support table.",
 )
 
@@ -260,7 +265,6 @@ def _ppf(q: NumericArray, **options: Any) -> NumericArray:
     fitter=fit_cdf_to_ppf_1D,
     options=(),
     constraint_tags=frozenset({"discrete", "univariate"}),
-    priority=0,
     description="CDF -> PPF via searchsorted inversion on the support table.",
 )
 
@@ -352,6 +356,17 @@ def _cdf(x: NumericArray, **options: Any) -> NumericArray:
         ),
     ),
     constraint_tags=frozenset({"discrete", "univariate"}),
-    priority=0,
     description="PPF -> CDF via grid probing and step-function table construction.",
 )
+
+
+__all__ = [
+    "fit_pmf_to_cdf_1D",
+    "FITTER_PMF_TO_CDF_1D",
+    "fit_cdf_to_pmf_1D",
+    "FITTER_CDF_TO_PMF_1D",
+    "fit_cdf_to_ppf_1D",
+    "FITTER_CDF_TO_PPF_1D",
+    "fit_ppf_to_cdf_1D",
+    "FITTER_PPF_TO_CDF_1D",
+]

src/pysatl_core/distributions/computations/helpers.py

@@ -1,6 +1,13 @@
+"""
+Shared helper utilities for fitter and evaluator implementations.
+
+Provides support resolution, tail-table construction, support-bound
+estimation, and scalar-unwrapping helpers.
+"""
+
 from __future__ import annotations
 
-__author__ = "Leonid Elkin, Mikhail Mikhailov, Irina Sergeeva"
+__author__ = "Irina Sergeeva"
 __copyright__ = "Copyright (c) 2025 PySATL project"
 __license__ = "SPDX-License-Identifier: MIT"
 
@@ -272,3 +279,12 @@ def maybe_unwrap_scalar(result: np.ndarray) -> NumericArray:
     if result.shape == (1,):
         return cast("NumericArray", result[0])
     return cast("NumericArray", result)
+
+
+__all__ = [
+    "resolve",
+    "collect_support",
+    "build_tail_table",
+    "estimate_support_bounds",
+    "maybe_unwrap_scalar",
+]