gwkokab.analysis.utils.checks
=============================

.. py:module:: gwkokab.analysis.utils.checks


Functions
---------

.. autoapisummary::

   gwkokab.analysis.utils.checks.check_min_concentration_for_beta_dist


Module Contents
---------------

.. py:function:: check_min_concentration_for_beta_dist(loc: jaxtyping.Array, var: jaxtyping.Array, /, *, alpha_min: Union[jaxtyping.Array, float] = 1.0, beta_min: Union[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.

   .. math::
       \alpha > \alpha_{\mathrm{min}} \iff \mu^2 (1 - \mu) > \sigma^2 (\alpha_{\mathrm{min}} + \mu)

   .. math::
       \beta > \beta_{\mathrm{min}} \iff \mu (1 - \mu)^2 > \sigma^2 (\beta_{\mathrm{min}} + 1 - \mu)

   :param loc: The location parameter (mean).
   :type loc: Array
   :param var: The variance parameter.
   :type var: Array
   :param alpha_min: The minimum allowed value for alpha, default is 1.0.
   :type alpha_min: Union[Array, float]
   :param beta_min: The minimum allowed value for beta, default is 1.0.
   :type beta_min: Union[Array, float]

   :returns: A boolean array indicating whether the constraints are satisfied.
   :rtype: Array