# probcalc - Calculate probabilities for distributions
# Copyright (C) 2022 D. Dyson (DoctorDalek1963)

# This program is licensed under GNU GPLv3, available here:
# <https://www.gnu.org/licenses/gpl-3.0.html>

"""This is the top-level ``probcalc`` package, which contains all the subpackages and submodules of the project.

Here's a table of user-friendly aliases and the backend classes they refer to:

.. list-table::
   :widths: 20 70
   :header-rows: 1

   * - Alias
     - Class name
   * - P
     - :class:`probcalc.distribution_classes.ProbabilityCalculator`
   * - B
     - :class:`probcalc.distributions.BinomialDistribution`
   * - Po
     - :class:`probcalc.distributions.PoissonDistribution`
   * - N
     - :class:`probcalc.distributions.NormalDistribution`
   * - Geo
     - :class:`probcalc.distributions.GeometricDistribution`
"""

from . import distribution_classes, distributions, utility
from .distribution_classes import NonsenseError

P = distribution_classes.ProbabilityCalculator()
B = distributions.BinomialDistribution
Po = distributions.PoissonDistribution
N = distributions.NormalDistribution
Geo = distributions.GeometricDistribution

__all__ = ['P', 'B', 'Po', 'N', 'Geo', 'NonsenseError', 'distributions', 'utility']

__version__ = '0.5.0'
