BF-MATH-STATISTICS - Statistical functionalities

$../../../../../../_images/MLPro-BF-Math-Statistics_class_diagram.drawio.png$

Ver. 0.2.0 (2025-06-04)

This module provides classes for the standardized use of value boundaries.

class mlpro.bf.math.statistics.boundaries.BoundarySide(value)

Bases: IntEnum

LOWER = 0

UPPER = 1

class mlpro.bf.math.statistics.boundaries.BoundaryProvider

Bases: object

Standardizes the provision/computation of boundaries.

static create_boundaries(p_num_dim: int) → ndarray[tuple[Any, ...], dtype[float64]]: Static service method to create a two-dim array for boundaries.

_create_boundaries(p_num_dim: int) → ndarray[tuple[Any, ...], dtype[float64]]: Internal service method to create a two-dim array for boundaries.

get_boundaries(p_dim: int = None, p_side: BoundarySide = None, p_copy: bool = False) → ndarray[tuple[Any, ...], dtype[float64]] | float

Returns the current value boundaries of internally stored data. The result can be reduced by the optional parameters p_side, p_dim. If both parameters are specified, the result is a float.

Parameters:

p_dim (int = None) – Optionally reduces the result to a particular dimension.
p_side (BoundarySide = None) – Optionally reduces the result to upper or lower boundaries. See class BoundarySide for possible values.
p_copy (bool = False) – If True, a copy of the boudaries is returned. Otherwise (default), a reference to the internal boundary array is returned.

Returns:

Returns the current boundaries of the data. The return value depends on the combination of the optional parameters: - If neither p_side nor p_dim is specified: returns the full 2×n array. - If only p_side is specified: returns a 1D array with values for all dimensions. - If only p_dim is specified: returns a 1D array with both lower and upper bounds. - If both p_side and p_dim are specified: returns a single float value.

Return type:

Union[Boundaries, float]