scipy.stats.gausshyper

scipy.stats.gausshyper()

A Gauss hypergeometric 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

a,b,c,z : 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’)

Methods:

gausshyper.rvs(a,b,c,z,loc=0,scale=1,size=1) :

• random variates

gausshyper.pdf(x,a,b,c,z,loc=0,scale=1) :

• probability density function

gausshyper.cdf(x,a,b,c,z,loc=0,scale=1) :

• cumulative density function

gausshyper.sf(x,a,b,c,z,loc=0,scale=1) :

• survival function (1-cdf — sometimes more accurate)

gausshyper.ppf(q,a,b,c,z,loc=0,scale=1) :

• percent point function (inverse of cdf — percentiles)

gausshyper.isf(q,a,b,c,z,loc=0,scale=1) :

• inverse survival function (inverse of sf)

gausshyper.stats(a,b,c,z,loc=0,scale=1,moments=’mv’) :

• mean(‘m’), variance(‘v’), skew(‘s’), and/or kurtosis(‘k’)

gausshyper.entropy(a,b,c,z,loc=0,scale=1) :

• (differential) entropy of the RV.

gausshyper.fit(data,a,b,c,z,loc=0,scale=1) :

• Parameter estimates for gausshyper 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 = gausshyper(a,b,c,z,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 = gausshyper.numargs
>>> [ a,b,c,z ] = [0.9,]*numargs
>>> rv = gausshyper(a,b,c,z)

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 = gausshyper.cdf(x,a,b,c,z)
>>> h=plt.semilogy(np.abs(x-gausshyper.ppf(prb,c))+1e-20)

Random number generation

>>> R = gausshyper.rvs(a,b,c,z,size=100)

Gauss hypergeometric distribution

gausshyper.pdf(x,a,b,c,z) = C * x**(a-1) * (1-x)**(b-1) * (1+z*x)**(-c) for 0 <= x <= 1, a > 0, b > 0, and C = 1/(B(a,b)F[2,1](c,a;a+b;-z))