_distribution module¶
- class pyrockfall.stats._distribution.DistributionID(*values)[source]¶
Bases:
IntEnumEnum for supported probability distribution types.
- NOTDEFINED = 0¶
- NONE = 1¶
- NORMAL = 2¶
- UNIFORM = 3¶
- TRIANGULAR = 4¶
- BETA = 5¶
- EXPONENTIAL = 6¶
- LOGNORMAL = 7¶
- GAMMA = 8¶
- class pyrockfall.stats._distribution.DistributionParameters(id: int | DistributionID, loc: float, scale: float, min_raw: float, max_raw: float, relative: bool)[source]¶
Bases:
object- static relative(id: int | DistributionID, loc: float, scale: float, rel_min: float, rel_max: float) DistributionParameters[source]¶
min/max are interpreted as OFFSETS relative to loc.
- static absolute(id: int | DistributionID, loc: float, scale: float, abs_min: float, abs_max: float) DistributionParameters[source]¶
min/max are interpreted as absolute values.
- pyrockfall.stats._distribution.registerDistribution(id_: DistributionID)[source]¶
Decorator to register concrete distributions.
- class pyrockfall.stats._distribution.Distribution[source]¶
Bases:
ABCAbstract base class for random variables.
Defines the API for all random variable classes in pyrockfall.
- DistID: DistributionID = 0¶
- abstractmethod rvs(size: int = 1, random_state: int | Generator | None = None) ndarray[source]¶
Random variates
- abstractmethod expect(func: Callable, lb: float = -inf, ub: float = inf) float[source]¶
Expected value of a function of the random variable over [lb, ub]
- abstractmethod interval(confidence: float = 1.0) Tuple[float, float][source]¶
Confidence interval having equal areas around the median
- abstractmethod native_params() dict[str, float][source]¶
Constructor-ready, family-specific parameters (e.g., {‘mu’:…, ‘sigma’:…}).
- abstractmethod generic_params() DistributionParameters[source]¶
Family-agnostic summary: loc, scale, rel_min, rel_max