Hyperbolic secant distribution¶
The wikipedia article
provides information about the distribution. The scale parameter used here matches that of SciPy’s scipy.special.hypsecant; it is 2/pi times the scale parameter used in the wikipedia article.
- mpsci.distributions.hypsecant.cdf(x, loc=0, scale=1)¶
Cumulative distribution function for the hyperbolic secant distribution.
- mpsci.distributions.hypsecant.entropy(loc=0, scale=1)¶
Differential entropy of the hyperbolic secant distribution.
- mpsci.distributions.hypsecant.invcdf(p, loc=0, scale=1)¶
Inverse of the CDF for the hyperbolic secant distribution.
This function is also known as the quantile function or the percent point function.
- mpsci.distributions.hypsecant.invsf(p, loc=0, scale=1)¶
Inverse of the survival function of the hyperblic secant distribution.
- mpsci.distributions.hypsecant.logpdf(x, loc=0, scale=1)¶
Logarithm of the PDF of the hyperbolic secant distribution.
- mpsci.distributions.hypsecant.mean(loc=0, scale=1)¶
Mean of the hyperbolic secant distribution.
- mpsci.distributions.hypsecant.mle(x, *, loc=None, scale=None)¶
Maximum likelihood estimate for the hyperbolic secant distribution.
x must be a sequence of numbers.
Provide a numerical argument to loc or scale to fix that parameter. Provide an instance of mpsci.distributions.Initial to override the default initial value for the parmeter to be used in the numerical root-finding.
- mpsci.distributions.hypsecant.nll(x, loc, scale)¶
Negative log-likelihood of the hyperbolic secant distribution.
x must be a sequence of nonnegative numbers.
- mpsci.distributions.hypsecant.pdf(x, loc=0, scale=1)¶
Probability density function for the hyperbolic secant distribution.
- mpsci.distributions.hypsecant.sf(x, loc=0, scale=1)¶
Survival function for the hyperbolic secant distribution.
- mpsci.distributions.hypsecant.support(loc=0, scale=1)¶
Support of the hyperbolic secant distribution.
- mpsci.distributions.hypsecant.var(loc=0, scale=1)¶
Variance of the hyperbolic secant distribution.