gwkokab.analysis.utils.checks

Functions

check_min_concentration_for_beta_dist(→ jaxtyping.Array)

Check if the mean and variance are valid for a given minimum alpha and beta of a

Module Contents

gwkokab.analysis.utils.checks.check_min_concentration_for_beta_dist(loc: jaxtyping.Array, var: jaxtyping.Array, /, *, alpha_min: jaxtyping.Array | float = 1.0, beta_min: jaxtyping.Array | float = 1.0) → jaxtyping.Array

Check if the mean and variance are valid for a given minimum alpha and beta of a Beta distribution.

\[\alpha > \alpha_{\mathrm{min}} \iff \mu^2 (1 - \mu) > \sigma^2 (\alpha_{\mathrm{min}} + \mu)\]

\[\beta > \beta_{\mathrm{min}} \iff \mu (1 - \mu)^2 > \sigma^2 (\beta_{\mathrm{min}} + 1 - \mu)\]

Parameters:

• loc (Array) – The location parameter (mean).

• var (Array) – The variance parameter.

• alpha_min (Union[Array, float]) – The minimum allowed value for alpha, default is 1.0.

• beta_min (Union[Array, float]) – The minimum allowed value for beta, default is 1.0.

Returns:

A boolean array indicating whether the constraints are satisfied.

Return type:

Array