This is a pre-release version (2.5.0.dev0+git20251130.2de293a). Go to latest (2.4.4)
{ } Raw JSON

bundles / numpy 2.5.0.dev0+git20251130.2de293a / numpy / random / _generator / Generator / noncentral_chisquare

cython_function_or_method

numpy.random._generator:Generator.noncentral_chisquare

Signature

def   noncentral_chisquare ( df nonc size = None )

Summary

Draw samples from a noncentral chi-square distribution.

Extended Summary

The noncentral distribution is a generalization of the distribution.

Parameters

df : float or array_like of floats

Degrees of freedom, must be > 0.

nonc : float or array_like of floats

Non-centrality, 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 df and nonc are both scalars. Otherwise, np.broadcast(df, nonc).size samples are drawn.

Returns

out : ndarray or scalar

Drawn samples from the parameterized noncentral chi-square distribution.

Notes

The probability density function for the noncentral Chi-square distribution is

where is the Chi-square with q degrees of freedom.

Examples

Draw values from the distribution and plot the histogram
rng = np.random.default_rng()
import matplotlib.pyplot as plt
values = plt.hist(rng.noncentral_chisquare(3, 20, 100000),
                  bins=200, density=True)
plt.show()
fig-29133d2c57c85011.png
Draw values from a noncentral chisquare with very small noncentrality, and compare to a chisquare.
plt.figure()
values = plt.hist(rng.noncentral_chisquare(3, .0000001, 100000),
                  bins=np.arange(0., 25, .1), density=True)
values2 = plt.hist(rng.chisquare(3, 100000),
                   bins=np.arange(0., 25, .1), density=True)
plt.plot(values[1][0:-1], values[0]-values2[0], 'ob')
plt.show()
fig-330ffd86726eeb59.png
Demonstrate how large values of non-centrality lead to a more symmetric distribution.
plt.figure()
values = plt.hist(rng.noncentral_chisquare(3, 20, 100000),
                  bins=200, density=True)
plt.show()
fig-d7c16fb4149cceb8.png

Aliases

  • numpy.random.Generator.noncentral_chisquare

Referenced by