You are viewing an older version (2.4.3). Go to latest (2.4.4)
{ } Raw JSON

bundles / numpy 2.4.3 / numpy / random / _generator / Generator / pareto

cython_function_or_method

numpy.random._generator:Generator.pareto

Signature

def   pareto ( a size = None )

Summary

Draw samples from a Pareto II (AKA Lomax) distribution with specified shape.

Parameters

a : float or array_like of floats

Shape of the distribution. Must be positive.

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 a is a scalar. Otherwise, np.array(a).size samples are drawn.

Returns

out : ndarray or scalar

Drawn samples from the Pareto II distribution.

Notes

The probability density for the Pareto II distribution is

where is the shape.

The Pareto II distribution is a shifted and scaled version of the Pareto I distribution, which can be found in scipy.stats.pareto.

Examples

Draw samples from the distribution:
a = 3.
rng = np.random.default_rng()
s = rng.pareto(a, 10000)
Display the histogram of the samples, along with the probability density function:
import matplotlib.pyplot as plt
x = np.linspace(0, 3, 50)
pdf = a / (x+1)**(a+1)
plt.hist(s, bins=x, density=True, label='histogram')
plt.plot(x, pdf, linewidth=2, color='r', label='pdf')
plt.xlim(x.min(), x.max())
plt.legend()
plt.show()
fig-072d15fcffb36c06.png

See also

scipy.stats.genpareto

Generalized Pareto distribution

scipy.stats.lomax

Lomax (Pareto II) distribution

scipy.stats.pareto

Pareto I distribution

Aliases

  • numpy.random.Generator.pareto

Referenced by