This is a pre-release version (latest). Go to latest (2.4.4)
{ } Raw JSON

bundles / numpy latest / numpy / random / _generator / Generator / standard_gamma

cython_function_or_method

numpy.random._generator:Generator.standard_gamma

Summary

Draw samples from a standard Gamma distribution.

Extended Summary

Samples are drawn from a Gamma distribution with specified parameters, shape (sometimes designated "k") and scale=1.

Parameters

shape : float or array_like of floats

Parameter, must be non-negative.

size : int or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn. If size is None (default), a single value is returned if shape is a scalar. Otherwise, np.array(shape).size samples are drawn.

dtype : dtype, optional

Desired dtype of the result, only float64 and float32 are supported. Byteorder must be native. The default value is np.float64.

out : ndarray, optional

Alternative output array in which to place the result. If size is not None, it must have the same shape as the provided size and must match the type of the output values.

Returns

out : ndarray or scalar

Drawn samples from the parameterized standard gamma distribution.

Notes

The probability density for the Gamma distribution is

where is the shape and the scale, and is the Gamma function.

The Gamma distribution is often used to model the times to failure of electronic components, and arises naturally in processes for which the waiting times between Poisson distributed events are relevant.

Examples

Draw samples from the distribution:
shape, scale = 2., 1. # mean and width
rng = np.random.default_rng()
s = rng.standard_gamma(shape, 1000000)
Display the histogram of the samples, along with the probability density function:
import matplotlib.pyplot as plt
count, bins, _ = plt.hist(s, 50, density=True)
plt.show()
fig-fcafd8ab19bf09b4.png

See also

scipy.stats.gamma

probability density function, distribution or cumulative density function, etc.

Aliases

  • numpy.random.Generator.standard_gamma

Referenced by