Source code for UQpy.distributions.collection.Binomial

from typing import Union

import scipy.stats as stats
from beartype import beartype

from UQpy.distributions.baseclass import DistributionDiscrete1D


class Binomial(DistributionDiscrete1D):
    @beartype
    def __init__(
        self,
        n: Union[None, int],
        p: Union[None, float, int],
        loc: Union[None, float, int] = 0.0,
    ):
        """

        :param n: number of trials, integer :math:`\ge 0`
        :param p: success probability for each trial, real number in :math:`[0, 1]`.
        :param loc: location parameter
        """
        super().__init__(n=n, p=p, loc=loc, ordered_parameters=("n", "p", "loc"))
        self._construct_from_scipy(scipy_name=stats.binom)