scipy.stats.hypsecant¶

scipy.stats.hypsecant()

A hyperbolic secant continuous random variable.

Continuous random variables are defined from a standard form and may require some shape parameters to complete its specification. Any optional keyword parameters can be passed to the methods of the RV object as given below:

Parameters: x : array-like quantiles q : array-like lower or upper tail probability : array-like shape parameters loc : array-like, optional location parameter (default=0) scale : array-like, optional scale parameter (default=1) size : int or tuple of ints, optional shape of random variates (default computed from input arguments ) moments : string, optional composed of letters [‘mvsk’] specifying which moments to compute where ‘m’ = mean, ‘v’ = variance, ‘s’ = (Fisher’s) skew and ‘k’ = (Fisher’s) kurtosis. (default=’mv’) hypsecant.rvs(loc=0,scale=1,size=1) : random variates hypsecant.pdf(x,loc=0,scale=1) : probability density function hypsecant.cdf(x,loc=0,scale=1) : cumulative density function hypsecant.sf(x,loc=0,scale=1) : survival function (1-cdf — sometimes more accurate) hypsecant.ppf(q,loc=0,scale=1) : percent point function (inverse of cdf — percentiles) hypsecant.isf(q,loc=0,scale=1) : inverse survival function (inverse of sf) hypsecant.stats(loc=0,scale=1,moments=’mv’) : mean(‘m’), variance(‘v’), skew(‘s’), and/or kurtosis(‘k’) hypsecant.entropy(loc=0,scale=1) : (differential) entropy of the RV. hypsecant.fit(data,loc=0,scale=1) : Parameter estimates for hypsecant data Alternatively, the object may be called (as a function) to fix the shape, : location, and scale parameters returning a “frozen” continuous RV object: : rv = hypsecant(loc=0,scale=1) : frozen RV object with the same methods but holding the given shape, location, and scale fixed

Examples

```>>> import matplotlib.pyplot as plt
>>> numargs = hypsecant.numargs
>>> [ <shape(s)> ] = [0.9,]*numargs
>>> rv = hypsecant(<shape(s)>)
```

Display frozen pdf

```>>> x = np.linspace(0,np.minimum(rv.dist.b,3))
>>> h=plt.plot(x,rv.pdf(x))
```

Check accuracy of cdf and ppf

```>>> prb = hypsecant.cdf(x,<shape(s)>)
>>> h=plt.semilogy(np.abs(x-hypsecant.ppf(prb,c))+1e-20)
```

Random number generation

```>>> R = hypsecant.rvs(size=100)
```

Hyperbolic secant distribution

hypsecant.pdf(x) = 1/pi * sech(x)

Previous topic

scipy.stats.halfnorm

Next topic

scipy.stats.invgamma