numpy.random.PCG64.advance method   random.PCG64.advance(delta)

Advance the underlying RNG as-if delta draws have occurred.  Parameters

deltainteger, positive

Number of draws to advance the RNG. Must be less than the size state variable in the underlying RNG.    Returns

selfPCG64

RNG advanced delta steps     Notes Advancing a RNG updates the underlying RNG state as-if a given number of calls to the underlying RNG have been made. In general there is not a one-to-one relationship between the number output random values from a particular distribution and the number of draws from the core RNG. This occurs for two reasons:  The random values are simulated using a rejection-based method and so, on average, more than one value from the underlying RNG is required to generate an single draw. The number of bits required to generate a simulated value differs from the number of bits generated by the underlying RNG. For example, two 16-bit integer values can be simulated from a single draw of a 32-bit RNG.  Advancing the RNG state resets any pre-computed random numbers. This is required to ensure exact reproducibility.


numpy.random.PCG64.cffi attribute   random.PCG64.cffi

CFFI interface  Returns

interfacenamedtuple

Named tuple containing CFFI wrapper  state_address - Memory address of the state struct state - pointer to the state struct next_uint64 - function pointer to produce 64 bit integers next_uint32 - function pointer to produce 32 bit integers next_double - function pointer to produce doubles bitgen - pointer to the bit generator struct


numpy.random.PCG64.ctypes attribute   random.PCG64.ctypes

ctypes interface  Returns

interfacenamedtuple

Named tuple containing ctypes wrapper  state_address - Memory address of the state struct state - pointer to the state struct next_uint64 - function pointer to produce 64 bit integers next_uint32 - function pointer to produce 32 bit integers next_double - function pointer to produce doubles bitgen - pointer to the bit generator struct


numpy.random.PCG64.jumped method   random.PCG64.jumped(jumps=1)

Returns a new bit generator with the state jumped. Jumps the state as-if jumps * 210306068529402873165736369884012333109 random numbers have been generated.  Parameters

jumpsinteger, positive

Number of times to jump the state of the bit generator returned    Returns

bit_generatorPCG64

New instance of generator jumped iter times     Notes The step size is phi-1 when multiplied by 2**128 where phi is the golden ratio.


numpy.random.PCG64.state attribute   random.PCG64.state

Get or set the PRNG state  Returns

statedict

Dictionary containing the information required to describe the state of the PRNG


numpy.random.PCG64DXSM.advance method   random.PCG64DXSM.advance(delta)

Advance the underlying RNG as-if delta draws have occurred.  Parameters

deltainteger, positive

Number of draws to advance the RNG. Must be less than the size state variable in the underlying RNG.    Returns

selfPCG64

RNG advanced delta steps     Notes Advancing a RNG updates the underlying RNG state as-if a given number of calls to the underlying RNG have been made. In general there is not a one-to-one relationship between the number output random values from a particular distribution and the number of draws from the core RNG. This occurs for two reasons:  The random values are simulated using a rejection-based method and so, on average, more than one value from the underlying RNG is required to generate an single draw. The number of bits required to generate a simulated value differs from the number of bits generated by the underlying RNG. For example, two 16-bit integer values can be simulated from a single draw of a 32-bit RNG.  Advancing the RNG state resets any pre-computed random numbers. This is required to ensure exact reproducibility.


numpy.random.PCG64DXSM.cffi attribute   random.PCG64DXSM.cffi

CFFI interface  Returns

interfacenamedtuple

Named tuple containing CFFI wrapper  state_address - Memory address of the state struct state - pointer to the state struct next_uint64 - function pointer to produce 64 bit integers next_uint32 - function pointer to produce 32 bit integers next_double - function pointer to produce doubles bitgen - pointer to the bit generator struct


numpy.random.PCG64DXSM.ctypes attribute   random.PCG64DXSM.ctypes

ctypes interface  Returns

interfacenamedtuple

Named tuple containing ctypes wrapper  state_address - Memory address of the state struct state - pointer to the state struct next_uint64 - function pointer to produce 64 bit integers next_uint32 - function pointer to produce 32 bit integers next_double - function pointer to produce doubles bitgen - pointer to the bit generator struct


numpy.random.PCG64DXSM.jumped method   random.PCG64DXSM.jumped(jumps=1)

Returns a new bit generator with the state jumped. Jumps the state as-if jumps * 210306068529402873165736369884012333109 random numbers have been generated.  Parameters

jumpsinteger, positive

Number of times to jump the state of the bit generator returned    Returns

bit_generatorPCG64DXSM

New instance of generator jumped iter times     Notes The step size is phi-1 when multiplied by 2**128 where phi is the golden ratio.


numpy.random.PCG64DXSM.state attribute   random.PCG64DXSM.state

Get or set the PRNG state  Returns

statedict

Dictionary containing the information required to describe the state of the PRNG


numpy.random.permutation   random.permutation(x)

Randomly permute a sequence, or return a permuted range. If x is a multi-dimensional array, it is only shuffled along its first index.  Note New code should use the permutation method of a default_rng() instance instead; please see the Quick Start.   Parameters

xint or array_like

If x is an integer, randomly permute np.arange(x). If x is an array, make a copy and shuffle the elements randomly.    Returns

outndarray

Permuted sequence or array range.      See also  Generator.permutation

which should be used for new code.    Examples >>> np.random.permutation(10)
array([1, 7, 4, 3, 0, 9, 2, 5, 8, 6]) # random
 >>> np.random.permutation([1, 4, 9, 12, 15])
array([15,  1,  9,  4, 12]) # random
 >>> arr = np.arange(9).reshape((3, 3))
>>> np.random.permutation(arr)
array([[6, 7, 8], # random
       [0, 1, 2],
       [3, 4, 5]])


numpy.random.Philox.advance method   random.Philox.advance(delta)

Advance the underlying RNG as-if delta draws have occurred.  Parameters

deltainteger, positive

Number of draws to advance the RNG. Must be less than the size state variable in the underlying RNG.    Returns

selfPhilox

RNG advanced delta steps     Notes Advancing a RNG updates the underlying RNG state as-if a given number of calls to the underlying RNG have been made. In general there is not a one-to-one relationship between the number output random values from a particular distribution and the number of draws from the core RNG. This occurs for two reasons:  The random values are simulated using a rejection-based method and so, on average, more than one value from the underlying RNG is required to generate an single draw. The number of bits required to generate a simulated value differs from the number of bits generated by the underlying RNG. For example, two 16-bit integer values can be simulated from a single draw of a 32-bit RNG.  Advancing the RNG state resets any pre-computed random numbers. This is required to ensure exact reproducibility.


numpy.random.Philox.cffi attribute   random.Philox.cffi

CFFI interface  Returns

interfacenamedtuple

Named tuple containing CFFI wrapper  state_address - Memory address of the state struct state - pointer to the state struct next_uint64 - function pointer to produce 64 bit integers next_uint32 - function pointer to produce 32 bit integers next_double - function pointer to produce doubles bitgen - pointer to the bit generator struct


numpy.random.Philox.ctypes attribute   random.Philox.ctypes

ctypes interface  Returns

interfacenamedtuple

Named tuple containing ctypes wrapper  state_address - Memory address of the state struct state - pointer to the state struct next_uint64 - function pointer to produce 64 bit integers next_uint32 - function pointer to produce 32 bit integers next_double - function pointer to produce doubles bitgen - pointer to the bit generator struct


numpy.random.Philox.jumped method   random.Philox.jumped(jumps=1)

Returns a new bit generator with the state jumped The state of the returned big generator is jumped as-if 2**(128 * jumps) random numbers have been generated.  Parameters

jumpsinteger, positive

Number of times to jump the state of the bit generator returned    Returns

bit_generatorPhilox

New instance of generator jumped iter times


numpy.random.Philox.state attribute   random.Philox.state

Get or set the PRNG state  Returns

statedict

Dictionary containing the information required to describe the state of the PRNG


numpy.random.poisson   random.poisson(lam=1.0, size=None)

Draw samples from a Poisson distribution. The Poisson distribution is the limit of the binomial distribution for large N.  Note New code should use the poisson method of a default_rng() instance instead; please see the Quick Start.   Parameters

lamfloat or array_like of floats

Expected number of events occurring in a fixed-time interval, must be >= 0. A sequence must be broadcastable over the requested size.
sizeint 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 lam is a scalar. Otherwise, np.array(lam).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized Poisson distribution.      See also  Generator.poisson

which should be used for new code.    Notes The Poisson distribution  \[f(k; \lambda)=\frac{\lambda^k e^{-\lambda}}{k!}\] For events with an expected separation \(\lambda\) the Poisson distribution \(f(k; \lambda)\) describes the probability of \(k\) events occurring within the observed interval \(\lambda\). Because the output is limited to the range of the C int64 type, a ValueError is raised when lam is within 10 sigma of the maximum representable value. References  1
Weisstein, Eric W. “Poisson Distribution.” From MathWorld–A Wolfram Web Resource. http://mathworld.wolfram.com/PoissonDistribution.html  2
Wikipedia, “Poisson distribution”, https://en.wikipedia.org/wiki/Poisson_distribution   Examples Draw samples from the distribution: >>> import numpy as np
>>> s = np.random.poisson(5, 10000)
 Display histogram of the sample: >>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(s, 14, density=True)
>>> plt.show()
    Draw each 100 values for lambda 100 and 500: >>> s = np.random.poisson(lam=(100., 500.), size=(100, 2))


numpy.random.power   random.power(a, size=None)

Draws samples in [0, 1] from a power distribution with positive exponent a - 1. Also known as the power function distribution.  Note New code should use the power method of a default_rng() instance instead; please see the Quick Start.   Parameters

afloat or array_like of floats

Parameter of the distribution. Must be non-negative.
sizeint 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

outndarray or scalar

Drawn samples from the parameterized power distribution.    Raises
 ValueError

If a <= 0.      See also  Generator.power

which should be used for new code.    Notes The probability density function is  \[P(x; a) = ax^{a-1}, 0 \le x \le 1, a>0.\] The power function distribution is just the inverse of the Pareto distribution. It may also be seen as a special case of the Beta distribution. It is used, for example, in modeling the over-reporting of insurance claims. References  1
Christian Kleiber, Samuel Kotz, “Statistical size distributions in economics and actuarial sciences”, Wiley, 2003.  2
Heckert, N. A. and Filliben, James J. “NIST Handbook 148: Dataplot Reference Manual, Volume 2: Let Subcommands and Library Functions”, National Institute of Standards and Technology Handbook Series, June 2003. https://www.itl.nist.gov/div898/software/dataplot/refman2/auxillar/powpdf.pdf   Examples Draw samples from the distribution: >>> a = 5. # shape
>>> samples = 1000
>>> s = np.random.power(a, samples)
 Display the histogram of the samples, along with the probability density function: >>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(s, bins=30)
>>> x = np.linspace(0, 1, 100)
>>> y = a*x**(a-1.)
>>> normed_y = samples*np.diff(bins)[0]*y
>>> plt.plot(x, normed_y)
>>> plt.show()
    Compare the power function distribution to the inverse of the Pareto. >>> from scipy import stats
>>> rvs = np.random.power(5, 1000000)
>>> rvsp = np.random.pareto(5, 1000000)
>>> xx = np.linspace(0,1,100)
>>> powpdf = stats.powerlaw.pdf(xx,5)
 >>> plt.figure()
>>> plt.hist(rvs, bins=50, density=True)
>>> plt.plot(xx,powpdf,'r-')
>>> plt.title('np.random.power(5)')
 >>> plt.figure()
>>> plt.hist(1./(1.+rvsp), bins=50, density=True)
>>> plt.plot(xx,powpdf,'r-')
>>> plt.title('inverse of 1 + np.random.pareto(5)')
 >>> plt.figure()
>>> plt.hist(1./(1.+rvsp), bins=50, density=True)
>>> plt.plot(xx,powpdf,'r-')
>>> plt.title('inverse of stats.pareto(5)')


numpy.random.rand   random.rand(d0, d1, ..., dn)

Random values in a given shape.  Note This is a convenience function for users porting code from Matlab, and wraps random_sample. That function takes a tuple to specify the size of the output, which is consistent with other NumPy functions like numpy.zeros and numpy.ones.  Create an array of the given shape and populate it with random samples from a uniform distribution over [0, 1).  Parameters

d0, d1, …, dnint, optional

The dimensions of the returned array, must be non-negative. If no argument is given a single Python float is returned.    Returns

outndarray, shape (d0, d1, ..., dn)

Random values.      See also  random
  Examples >>> np.random.rand(3,2)
array([[ 0.14022471,  0.96360618],  #random
       [ 0.37601032,  0.25528411],  #random
       [ 0.49313049,  0.94909878]]) #random


numpy.random.randint   random.randint(low, high=None, size=None, dtype=int)

Return random integers from low (inclusive) to high (exclusive). Return random integers from the “discrete uniform” distribution of the specified dtype in the “half-open” interval [low, high). If high is None (the default), then results are from [0, low).  Note New code should use the integers method of a default_rng() instance instead; please see the Quick Start.   Parameters

lowint or array-like of ints

Lowest (signed) integers to be drawn from the distribution (unless high=None, in which case this parameter is one above the highest such integer).
highint or array-like of ints, optional

If provided, one above the largest (signed) integer to be drawn from the distribution (see above for behavior if high=None). If array-like, must contain integer values
sizeint or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn. Default is None, in which case a single value is returned.
dtypedtype, optional

Desired dtype of the result. Byteorder must be native. The default value is int.  New in version 1.11.0.     Returns

outint or ndarray of ints

size-shaped array of random integers from the appropriate distribution, or a single such random int if size not provided.      See also  random_integers

similar to randint, only for the closed interval [low, high], and 1 is the lowest value if high is omitted.  Generator.integers

which should be used for new code.    Examples >>> np.random.randint(2, size=10)
array([1, 0, 0, 0, 1, 1, 0, 0, 1, 0]) # random
>>> np.random.randint(1, size=10)
array([0, 0, 0, 0, 0, 0, 0, 0, 0, 0])
 Generate a 2 x 4 array of ints between 0 and 4, inclusive: >>> np.random.randint(5, size=(2, 4))
array([[4, 0, 2, 1], # random
       [3, 2, 2, 0]])
 Generate a 1 x 3 array with 3 different upper bounds >>> np.random.randint(1, [3, 5, 10])
array([2, 2, 9]) # random
 Generate a 1 by 3 array with 3 different lower bounds >>> np.random.randint([1, 5, 7], 10)
array([9, 8, 7]) # random
 Generate a 2 by 4 array using broadcasting with dtype of uint8 >>> np.random.randint([1, 3, 5, 7], [[10], [20]], dtype=np.uint8)
array([[ 8,  6,  9,  7], # random
       [ 1, 16,  9, 12]], dtype=uint8)


numpy.random.randn   random.randn(d0, d1, ..., dn)

Return a sample (or samples) from the “standard normal” distribution.  Note This is a convenience function for users porting code from Matlab, and wraps standard_normal. That function takes a tuple to specify the size of the output, which is consistent with other NumPy functions like numpy.zeros and numpy.ones.   Note New code should use the standard_normal method of a default_rng() instance instead; please see the Quick Start.  If positive int_like arguments are provided, randn generates an array of shape (d0, d1, ..., dn), filled with random floats sampled from a univariate “normal” (Gaussian) distribution of mean 0 and variance 1. A single float randomly sampled from the distribution is returned if no argument is provided.  Parameters

d0, d1, …, dnint, optional

The dimensions of the returned array, must be non-negative. If no argument is given a single Python float is returned.    Returns

Zndarray or float

A (d0, d1, ..., dn)-shaped array of floating-point samples from the standard normal distribution, or a single such float if no parameters were supplied.      See also  standard_normal

Similar, but takes a tuple as its argument.  normal

Also accepts mu and sigma arguments.  Generator.standard_normal

which should be used for new code.    Notes For random samples from \(N(\mu, \sigma^2)\), use: sigma * np.random.randn(...) + mu Examples >>> np.random.randn()
2.1923875335537315  # random
 Two-by-four array of samples from N(3, 6.25): >>> 3 + 2.5 * np.random.randn(2, 4)
array([[-4.49401501,  4.00950034, -1.81814867,  7.29718677],   # random
       [ 0.39924804,  4.68456316,  4.99394529,  4.84057254]])  # random


numpy.random.random   random.random(size=None)

Return random floats in the half-open interval [0.0, 1.0). Alias for random_sample to ease forward-porting to the new random API.


numpy.random.random_integers   random.random_integers(low, high=None, size=None)

Random integers of type np.int_ between low and high, inclusive. Return random integers of type np.int_ from the “discrete uniform” distribution in the closed interval [low, high]. If high is None (the default), then results are from [1, low]. The np.int_ type translates to the C long integer type and its precision is platform dependent. This function has been deprecated. Use randint instead.  Deprecated since version 1.11.0.   Parameters

lowint

Lowest (signed) integer to be drawn from the distribution (unless high=None, in which case this parameter is the highest such integer).
highint, optional

If provided, the largest (signed) integer to be drawn from the distribution (see above for behavior if high=None).
sizeint or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn. Default is None, in which case a single value is returned.    Returns

outint or ndarray of ints

size-shaped array of random integers from the appropriate distribution, or a single such random int if size not provided.      See also  randint

Similar to random_integers, only for the half-open interval [low, high), and 0 is the lowest value if high is omitted.    Notes To sample from N evenly spaced floating-point numbers between a and b, use: a + (b - a) * (np.random.random_integers(N) - 1) / (N - 1.)
 Examples >>> np.random.random_integers(5)
4 # random
>>> type(np.random.random_integers(5))
<class 'numpy.int64'>
>>> np.random.random_integers(5, size=(3,2))
array([[5, 4], # random
       [3, 3],
       [4, 5]])
 Choose five random numbers from the set of five evenly-spaced numbers between 0 and 2.5, inclusive (i.e., from the set \({0, 5/8, 10/8, 15/8, 20/8}\)): >>> 2.5 * (np.random.random_integers(5, size=(5,)) - 1) / 4.
array([ 0.625,  1.25 ,  0.625,  0.625,  2.5  ]) # random
 Roll two six sided dice 1000 times and sum the results: >>> d1 = np.random.random_integers(1, 6, 1000)
>>> d2 = np.random.random_integers(1, 6, 1000)
>>> dsums = d1 + d2
 Display results as a histogram: >>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(dsums, 11, density=True)
>>> plt.show()


numpy.random.random_sample   random.random_sample(size=None)

Return random floats in the half-open interval [0.0, 1.0). Results are from the “continuous uniform” distribution over the stated interval. To sample \(Unif[a, b), b > a\) multiply the output of random_sample by (b-a) and add a: (b - a) * random_sample() + a
  Note New code should use the random method of a default_rng() instance instead; please see the Quick Start.   Parameters

sizeint or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn. Default is None, in which case a single value is returned.    Returns

outfloat or ndarray of floats

Array of random floats of shape size (unless size=None, in which case a single float is returned).      See also  Generator.random

which should be used for new code.    Examples >>> np.random.random_sample()
0.47108547995356098 # random
>>> type(np.random.random_sample())
<class 'float'>
>>> np.random.random_sample((5,))
array([ 0.30220482,  0.86820401,  0.1654503 ,  0.11659149,  0.54323428]) # random
 Three-by-two array of random numbers from [-5, 0): >>> 5 * np.random.random_sample((3, 2)) - 5
array([[-3.99149989, -0.52338984], # random
       [-2.99091858, -0.79479508],
       [-1.23204345, -1.75224494]])


numpy.random.RandomState.beta method   random.RandomState.beta(a, b, size=None)

Draw samples from a Beta distribution. The Beta distribution is a special case of the Dirichlet distribution, and is related to the Gamma distribution. It has the probability distribution function  \[f(x; a,b) = \frac{1}{B(\alpha, \beta)} x^{\alpha - 1} (1 - x)^{\beta - 1},\] where the normalization, B, is the beta function,  \[B(\alpha, \beta) = \int_0^1 t^{\alpha - 1} (1 - t)^{\beta - 1} dt.\] It is often seen in Bayesian inference and order statistics.  Note New code should use the beta method of a default_rng() instance instead; please see the Quick Start.   Parameters

afloat or array_like of floats

Alpha, positive (>0).
bfloat or array_like of floats

Beta, positive (>0).
sizeint 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 and b are both scalars. Otherwise, np.broadcast(a, b).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized beta distribution.      See also  Generator.beta

which should be used for new code.


numpy.random.RandomState.binomial method   random.RandomState.binomial(n, p, size=None)

Draw samples from a binomial distribution. Samples are drawn from a binomial distribution with specified parameters, n trials and p probability of success where n an integer >= 0 and p is in the interval [0,1]. (n may be input as a float, but it is truncated to an integer in use)  Note New code should use the binomial method of a default_rng() instance instead; please see the Quick Start.   Parameters

nint or array_like of ints

Parameter of the distribution, >= 0. Floats are also accepted, but they will be truncated to integers.
pfloat or array_like of floats

Parameter of the distribution, >= 0 and <=1.
sizeint 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 n and p are both scalars. Otherwise, np.broadcast(n, p).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized binomial distribution, where each sample is equal to the number of successes over the n trials.      See also  scipy.stats.binom

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

which should be used for new code.    Notes The probability density for the binomial distribution is  \[P(N) = \binom{n}{N}p^N(1-p)^{n-N},\] where \(n\) is the number of trials, \(p\) is the probability of success, and \(N\) is the number of successes. When estimating the standard error of a proportion in a population by using a random sample, the normal distribution works well unless the product p*n <=5, where p = population proportion estimate, and n = number of samples, in which case the binomial distribution is used instead. For example, a sample of 15 people shows 4 who are left handed, and 11 who are right handed. Then p = 4/15 = 27%. 0.27*15 = 4, so the binomial distribution should be used in this case. References  1
Dalgaard, Peter, “Introductory Statistics with R”, Springer-Verlag, 2002.  2
Glantz, Stanton A. “Primer of Biostatistics.”, McGraw-Hill, Fifth Edition, 2002.  3
Lentner, Marvin, “Elementary Applied Statistics”, Bogden and Quigley, 1972.  4
Weisstein, Eric W. “Binomial Distribution.” From MathWorld–A Wolfram Web Resource. http://mathworld.wolfram.com/BinomialDistribution.html  5
Wikipedia, “Binomial distribution”, https://en.wikipedia.org/wiki/Binomial_distribution   Examples Draw samples from the distribution: >>> n, p = 10, .5  # number of trials, probability of each trial
>>> s = np.random.binomial(n, p, 1000)
# result of flipping a coin 10 times, tested 1000 times.
 A real world example. A company drills 9 wild-cat oil exploration wells, each with an estimated probability of success of 0.1. All nine wells fail. What is the probability of that happening? Let’s do 20,000 trials of the model, and count the number that generate zero positive results. >>> sum(np.random.binomial(9, 0.1, 20000) == 0)/20000.
# answer = 0.38885, or 38%.


numpy.random.RandomState.bytes method   random.RandomState.bytes(length)

Return random bytes.  Note New code should use the bytes method of a default_rng() instance instead; please see the Quick Start.   Parameters

lengthint

Number of random bytes.    Returns

outbytes

String of length length.      See also  Generator.bytes

which should be used for new code.    Examples >>> np.random.bytes(10)
b' eh\x85\x022SZ\xbf\xa4' #random


numpy.random.RandomState.chisquare method   random.RandomState.chisquare(df, size=None)

Draw samples from a chi-square distribution. When df independent random variables, each with standard normal distributions (mean 0, variance 1), are squared and summed, the resulting distribution is chi-square (see Notes). This distribution is often used in hypothesis testing.  Note New code should use the chisquare method of a default_rng() instance instead; please see the Quick Start.   Parameters

dffloat or array_like of floats

Number of degrees of freedom, must be > 0.
sizeint 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 is a scalar. Otherwise, np.array(df).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized chi-square distribution.    Raises
 ValueError

When df <= 0 or when an inappropriate size (e.g. size=-1) is given.      See also  Generator.chisquare

which should be used for new code.    Notes The variable obtained by summing the squares of df independent, standard normally distributed random variables:  \[Q = \sum_{i=0}^{\mathtt{df}} X^2_i\] is chi-square distributed, denoted  \[Q \sim \chi^2_k.\] The probability density function of the chi-squared distribution is  \[p(x) = \frac{(1/2)^{k/2}}{\Gamma(k/2)} x^{k/2 - 1} e^{-x/2},\] where \(\Gamma\) is the gamma function,  \[\Gamma(x) = \int_0^{-\infty} t^{x - 1} e^{-t} dt.\] References  1
NIST “Engineering Statistics Handbook” https://www.itl.nist.gov/div898/handbook/eda/section3/eda3666.htm   Examples >>> np.random.chisquare(2,4)
array([ 1.89920014,  9.00867716,  3.13710533,  5.62318272]) # random


numpy.random.RandomState.choice method   random.RandomState.choice(a, size=None, replace=True, p=None)

Generates a random sample from a given 1-D array  New in version 1.7.0.   Note New code should use the choice method of a default_rng() instance instead; please see the Quick Start.   Parameters

a1-D array-like or int

If an ndarray, a random sample is generated from its elements. If an int, the random sample is generated as if it were np.arange(a)
sizeint or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn. Default is None, in which case a single value is returned.
replaceboolean, optional

Whether the sample is with or without replacement. Default is True, meaning that a value of a can be selected multiple times.
p1-D array-like, optional

The probabilities associated with each entry in a. If not given, the sample assumes a uniform distribution over all entries in a.    Returns

samplessingle item or ndarray

The generated random samples    Raises
 ValueError

If a is an int and less than zero, if a or p are not 1-dimensional, if a is an array-like of size 0, if p is not a vector of probabilities, if a and p have different lengths, or if replace=False and the sample size is greater than the population size      See also
randint, shuffle, permutation

Generator.choice

which should be used in new code    Notes Setting user-specified probabilities through p uses a more general but less efficient sampler than the default. The general sampler produces a different sample than the optimized sampler even if each element of p is 1 / len(a). Sampling random rows from a 2-D array is not possible with this function, but is possible with Generator.choice through its axis keyword. Examples Generate a uniform random sample from np.arange(5) of size 3: >>> np.random.choice(5, 3)
array([0, 3, 4]) # random
>>> #This is equivalent to np.random.randint(0,5,3)
 Generate a non-uniform random sample from np.arange(5) of size 3: >>> np.random.choice(5, 3, p=[0.1, 0, 0.3, 0.6, 0])
array([3, 3, 0]) # random
 Generate a uniform random sample from np.arange(5) of size 3 without replacement: >>> np.random.choice(5, 3, replace=False)
array([3,1,0]) # random
>>> #This is equivalent to np.random.permutation(np.arange(5))[:3]
 Generate a non-uniform random sample from np.arange(5) of size 3 without replacement: >>> np.random.choice(5, 3, replace=False, p=[0.1, 0, 0.3, 0.6, 0])
array([2, 3, 0]) # random
 Any of the above can be repeated with an arbitrary array-like instead of just integers. For instance: >>> aa_milne_arr = ['pooh', 'rabbit', 'piglet', 'Christopher']
>>> np.random.choice(aa_milne_arr, 5, p=[0.5, 0.1, 0.1, 0.3])
array(['pooh', 'pooh', 'pooh', 'Christopher', 'piglet'], # random
      dtype='<U11')


numpy.random.RandomState.dirichlet method   random.RandomState.dirichlet(alpha, size=None)

Draw samples from the Dirichlet distribution. Draw size samples of dimension k from a Dirichlet distribution. A Dirichlet-distributed random variable can be seen as a multivariate generalization of a Beta distribution. The Dirichlet distribution is a conjugate prior of a multinomial distribution in Bayesian inference.  Note New code should use the dirichlet method of a default_rng() instance instead; please see the Quick Start.   Parameters

alphasequence of floats, length k

Parameter of the distribution (length k for sample of length k).
sizeint or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n), then m * n * k samples are drawn. Default is None, in which case a vector of length k is returned.    Returns

samplesndarray,

The drawn samples, of shape (size, k).    Raises
 ValueError

If any value in alpha is less than or equal to zero      See also  Generator.dirichlet

which should be used for new code.    Notes The Dirichlet distribution is a distribution over vectors \(x\) that fulfil the conditions \(x_i>0\) and \(\sum_{i=1}^k x_i = 1\). The probability density function \(p\) of a Dirichlet-distributed random vector \(X\) is proportional to  \[p(x) \propto \prod_{i=1}^{k}{x^{\alpha_i-1}_i},\] where \(\alpha\) is a vector containing the positive concentration parameters. The method uses the following property for computation: let \(Y\) be a random vector which has components that follow a standard gamma distribution, then \(X = \frac{1}{\sum_{i=1}^k{Y_i}} Y\) is Dirichlet-distributed References  1
David McKay, “Information Theory, Inference and Learning Algorithms,” chapter 23, http://www.inference.org.uk/mackay/itila/  2
Wikipedia, “Dirichlet distribution”, https://en.wikipedia.org/wiki/Dirichlet_distribution   Examples Taking an example cited in Wikipedia, this distribution can be used if one wanted to cut strings (each of initial length 1.0) into K pieces with different lengths, where each piece had, on average, a designated average length, but allowing some variation in the relative sizes of the pieces. >>> s = np.random.dirichlet((10, 5, 3), 20).transpose()
 >>> import matplotlib.pyplot as plt
>>> plt.barh(range(20), s[0])
>>> plt.barh(range(20), s[1], left=s[0], color='g')
>>> plt.barh(range(20), s[2], left=s[0]+s[1], color='r')
>>> plt.title("Lengths of Strings")


numpy.random.RandomState.exponential method   random.RandomState.exponential(scale=1.0, size=None)

Draw samples from an exponential distribution. Its probability density function is  \[f(x; \frac{1}{\beta}) = \frac{1}{\beta} \exp(-\frac{x}{\beta}),\] for x > 0 and 0 elsewhere. \(\beta\) is the scale parameter, which is the inverse of the rate parameter \(\lambda = 1/\beta\). The rate parameter is an alternative, widely used parameterization of the exponential distribution [3]. The exponential distribution is a continuous analogue of the geometric distribution. It describes many common situations, such as the size of raindrops measured over many rainstorms [1], or the time between page requests to Wikipedia [2].  Note New code should use the exponential method of a default_rng() instance instead; please see the Quick Start.   Parameters

scalefloat or array_like of floats

The scale parameter, \(\beta = 1/\lambda\). Must be non-negative.
sizeint 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 scale is a scalar. Otherwise, np.array(scale).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized exponential distribution.      See also  Generator.exponential

which should be used for new code.    References  1
Peyton Z. Peebles Jr., “Probability, Random Variables and Random Signal Principles”, 4th ed, 2001, p. 57.  2
Wikipedia, “Poisson process”, https://en.wikipedia.org/wiki/Poisson_process  3
Wikipedia, “Exponential distribution”, https://en.wikipedia.org/wiki/Exponential_distribution


numpy.random.RandomState.f method   random.RandomState.f(dfnum, dfden, size=None)

Draw samples from an F distribution. Samples are drawn from an F distribution with specified parameters, dfnum (degrees of freedom in numerator) and dfden (degrees of freedom in denominator), where both parameters must be greater than zero. The random variate of the F distribution (also known as the Fisher distribution) is a continuous probability distribution that arises in ANOVA tests, and is the ratio of two chi-square variates.  Note New code should use the f method of a default_rng() instance instead; please see the Quick Start.   Parameters

dfnumfloat or array_like of floats

Degrees of freedom in numerator, must be > 0.
dfdenfloat or array_like of float

Degrees of freedom in denominator, must be > 0.
sizeint 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 dfnum and dfden are both scalars. Otherwise, np.broadcast(dfnum, dfden).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized Fisher distribution.      See also  scipy.stats.f

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

which should be used for new code.    Notes The F statistic is used to compare in-group variances to between-group variances. Calculating the distribution depends on the sampling, and so it is a function of the respective degrees of freedom in the problem. The variable dfnum is the number of samples minus one, the between-groups degrees of freedom, while dfden is the within-groups degrees of freedom, the sum of the number of samples in each group minus the number of groups. References  1
Glantz, Stanton A. “Primer of Biostatistics.”, McGraw-Hill, Fifth Edition, 2002.  2
Wikipedia, “F-distribution”, https://en.wikipedia.org/wiki/F-distribution   Examples An example from Glantz[1], pp 47-40: Two groups, children of diabetics (25 people) and children from people without diabetes (25 controls). Fasting blood glucose was measured, case group had a mean value of 86.1, controls had a mean value of 82.2. Standard deviations were 2.09 and 2.49 respectively. Are these data consistent with the null hypothesis that the parents diabetic status does not affect their children’s blood glucose levels? Calculating the F statistic from the data gives a value of 36.01. Draw samples from the distribution: >>> dfnum = 1. # between group degrees of freedom
>>> dfden = 48. # within groups degrees of freedom
>>> s = np.random.f(dfnum, dfden, 1000)
 The lower bound for the top 1% of the samples is : >>> np.sort(s)[-10]
7.61988120985 # random
 So there is about a 1% chance that the F statistic will exceed 7.62, the measured value is 36, so the null hypothesis is rejected at the 1% level.


numpy.random.RandomState.gamma method   random.RandomState.gamma(shape, scale=1.0, size=None)

Draw samples from a Gamma distribution. Samples are drawn from a Gamma distribution with specified parameters, shape (sometimes designated “k”) and scale (sometimes designated “theta”), where both parameters are > 0.  Note New code should use the gamma method of a default_rng() instance instead; please see the Quick Start.   Parameters

shapefloat or array_like of floats

The shape of the gamma distribution. Must be non-negative.
scalefloat or array_like of floats, optional

The scale of the gamma distribution. Must be non-negative. Default is equal to 1.
sizeint 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 and scale are both scalars. Otherwise, np.broadcast(shape, scale).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized gamma distribution.      See also  scipy.stats.gamma

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

which should be used for new code.    Notes The probability density for the Gamma distribution is  \[p(x) = x^{k-1}\frac{e^{-x/\theta}}{\theta^k\Gamma(k)},\] where \(k\) is the shape and \(\theta\) the scale, and \(\Gamma\) 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. References  1
Weisstein, Eric W. “Gamma Distribution.” From MathWorld–A Wolfram Web Resource. http://mathworld.wolfram.com/GammaDistribution.html  2
Wikipedia, “Gamma distribution”, https://en.wikipedia.org/wiki/Gamma_distribution   Examples Draw samples from the distribution: >>> shape, scale = 2., 2.  # mean=4, std=2*sqrt(2)
>>> s = np.random.gamma(shape, scale, 1000)
 Display the histogram of the samples, along with the probability density function: >>> import matplotlib.pyplot as plt
>>> import scipy.special as sps
>>> count, bins, ignored = plt.hist(s, 50, density=True)
>>> y = bins**(shape-1)*(np.exp(-bins/scale) /
...                      (sps.gamma(shape)*scale**shape))
>>> plt.plot(bins, y, linewidth=2, color='r')
>>> plt.show()


numpy.random.RandomState.geometric method   random.RandomState.geometric(p, size=None)

Draw samples from the geometric distribution. Bernoulli trials are experiments with one of two outcomes: success or failure (an example of such an experiment is flipping a coin). The geometric distribution models the number of trials that must be run in order to achieve success. It is therefore supported on the positive integers, k = 1, 2, .... The probability mass function of the geometric distribution is  \[f(k) = (1 - p)^{k - 1} p\] where p is the probability of success of an individual trial.  Note New code should use the geometric method of a default_rng() instance instead; please see the Quick Start.   Parameters

pfloat or array_like of floats

The probability of success of an individual trial.
sizeint 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 p is a scalar. Otherwise, np.array(p).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized geometric distribution.      See also  Generator.geometric

which should be used for new code.    Examples Draw ten thousand values from the geometric distribution, with the probability of an individual success equal to 0.35: >>> z = np.random.geometric(p=0.35, size=10000)
 How many trials succeeded after a single run? >>> (z == 1).sum() / 10000.
0.34889999999999999 #random


numpy.random.RandomState.get_state method   random.RandomState.get_state()

Return a tuple representing the internal state of the generator. For more details, see set_state.  Parameters

legacybool, optional

Flag indicating to return a legacy tuple state when the BitGenerator is MT19937, instead of a dict.    Returns

out{tuple(str, ndarray of 624 uints, int, int, float), dict}

The returned tuple has the following items:  the string ‘MT19937’. a 1-D array of 624 unsigned integer keys. an integer pos. an integer has_gauss. a float cached_gaussian.  If legacy is False, or the BitGenerator is not MT19937, then state is returned as a dictionary.      See also  set_state
  Notes set_state and get_state are not needed to work with any of the random distributions in NumPy. If the internal state is manually altered, the user should know exactly what he/she is doing.


numpy.random.RandomState.gumbel method   random.RandomState.gumbel(loc=0.0, scale=1.0, size=None)

Draw samples from a Gumbel distribution. Draw samples from a Gumbel distribution with specified location and scale. For more information on the Gumbel distribution, see Notes and References below.  Note New code should use the gumbel method of a default_rng() instance instead; please see the Quick Start.   Parameters

locfloat or array_like of floats, optional

The location of the mode of the distribution. Default is 0.
scalefloat or array_like of floats, optional

The scale parameter of the distribution. Default is 1. Must be non- negative.
sizeint 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 loc and scale are both scalars. Otherwise, np.broadcast(loc, scale).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized Gumbel distribution.      See also  scipy.stats.gumbel_l
scipy.stats.gumbel_r
scipy.stats.genextreme
weibull
Generator.gumbel

which should be used for new code.    Notes The Gumbel (or Smallest Extreme Value (SEV) or the Smallest Extreme Value Type I) distribution is one of a class of Generalized Extreme Value (GEV) distributions used in modeling extreme value problems. The Gumbel is a special case of the Extreme Value Type I distribution for maximums from distributions with “exponential-like” tails. The probability density for the Gumbel distribution is  \[p(x) = \frac{e^{-(x - \mu)/ \beta}}{\beta} e^{ -e^{-(x - \mu)/ \beta}},\] where \(\mu\) is the mode, a location parameter, and \(\beta\) is the scale parameter. The Gumbel (named for German mathematician Emil Julius Gumbel) was used very early in the hydrology literature, for modeling the occurrence of flood events. It is also used for modeling maximum wind speed and rainfall rates. It is a “fat-tailed” distribution - the probability of an event in the tail of the distribution is larger than if one used a Gaussian, hence the surprisingly frequent occurrence of 100-year floods. Floods were initially modeled as a Gaussian process, which underestimated the frequency of extreme events. It is one of a class of extreme value distributions, the Generalized Extreme Value (GEV) distributions, which also includes the Weibull and Frechet. The function has a mean of \(\mu + 0.57721\beta\) and a variance of \(\frac{\pi^2}{6}\beta^2\). References  1
Gumbel, E. J., “Statistics of Extremes,” New York: Columbia University Press, 1958.  2
Reiss, R.-D. and Thomas, M., “Statistical Analysis of Extreme Values from Insurance, Finance, Hydrology and Other Fields,” Basel: Birkhauser Verlag, 2001.   Examples Draw samples from the distribution: >>> mu, beta = 0, 0.1 # location and scale
>>> s = np.random.gumbel(mu, beta, 1000)
 Display the histogram of the samples, along with the probability density function: >>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(s, 30, density=True)
>>> plt.plot(bins, (1/beta)*np.exp(-(bins - mu)/beta)
...          * np.exp( -np.exp( -(bins - mu) /beta) ),
...          linewidth=2, color='r')
>>> plt.show()
    Show how an extreme value distribution can arise from a Gaussian process and compare to a Gaussian: >>> means = []
>>> maxima = []
>>> for i in range(0,1000) :
...    a = np.random.normal(mu, beta, 1000)
...    means.append(a.mean())
...    maxima.append(a.max())
>>> count, bins, ignored = plt.hist(maxima, 30, density=True)
>>> beta = np.std(maxima) * np.sqrt(6) / np.pi
>>> mu = np.mean(maxima) - 0.57721*beta
>>> plt.plot(bins, (1/beta)*np.exp(-(bins - mu)/beta)
...          * np.exp(-np.exp(-(bins - mu)/beta)),
...          linewidth=2, color='r')
>>> plt.plot(bins, 1/(beta * np.sqrt(2 * np.pi))
...          * np.exp(-(bins - mu)**2 / (2 * beta**2)),
...          linewidth=2, color='g')
>>> plt.show()


numpy.random.RandomState.hypergeometric method   random.RandomState.hypergeometric(ngood, nbad, nsample, size=None)

Draw samples from a Hypergeometric distribution. Samples are drawn from a hypergeometric distribution with specified parameters, ngood (ways to make a good selection), nbad (ways to make a bad selection), and nsample (number of items sampled, which is less than or equal to the sum ngood + nbad).  Note New code should use the hypergeometric method of a default_rng() instance instead; please see the Quick Start.   Parameters

ngoodint or array_like of ints

Number of ways to make a good selection. Must be nonnegative.
nbadint or array_like of ints

Number of ways to make a bad selection. Must be nonnegative.
nsampleint or array_like of ints

Number of items sampled. Must be at least 1 and at most ngood + nbad.
sizeint 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 ngood, nbad, and nsample are all scalars. Otherwise, np.broadcast(ngood, nbad, nsample).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized hypergeometric distribution. Each sample is the number of good items within a randomly selected subset of size nsample taken from a set of ngood good items and nbad bad items.      See also  scipy.stats.hypergeom

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

which should be used for new code.    Notes The probability density for the Hypergeometric distribution is  \[P(x) = \frac{\binom{g}{x}\binom{b}{n-x}}{\binom{g+b}{n}},\] where \(0 \le x \le n\) and \(n-b \le x \le g\) for P(x) the probability of x good results in the drawn sample, g = ngood, b = nbad, and n = nsample. Consider an urn with black and white marbles in it, ngood of them are black and nbad are white. If you draw nsample balls without replacement, then the hypergeometric distribution describes the distribution of black balls in the drawn sample. Note that this distribution is very similar to the binomial distribution, except that in this case, samples are drawn without replacement, whereas in the Binomial case samples are drawn with replacement (or the sample space is infinite). As the sample space becomes large, this distribution approaches the binomial. References  1
Lentner, Marvin, “Elementary Applied Statistics”, Bogden and Quigley, 1972.  2
Weisstein, Eric W. “Hypergeometric Distribution.” From MathWorld–A Wolfram Web Resource. http://mathworld.wolfram.com/HypergeometricDistribution.html  3
Wikipedia, “Hypergeometric distribution”, https://en.wikipedia.org/wiki/Hypergeometric_distribution   Examples Draw samples from the distribution: >>> ngood, nbad, nsamp = 100, 2, 10
# number of good, number of bad, and number of samples
>>> s = np.random.hypergeometric(ngood, nbad, nsamp, 1000)
>>> from matplotlib.pyplot import hist
>>> hist(s)
#   note that it is very unlikely to grab both bad items
 Suppose you have an urn with 15 white and 15 black marbles. If you pull 15 marbles at random, how likely is it that 12 or more of them are one color? >>> s = np.random.hypergeometric(15, 15, 15, 100000)
>>> sum(s>=12)/100000. + sum(s<=3)/100000.
#   answer = 0.003 ... pretty unlikely!


numpy.random.RandomState.laplace method   random.RandomState.laplace(loc=0.0, scale=1.0, size=None)

Draw samples from the Laplace or double exponential distribution with specified location (or mean) and scale (decay). The Laplace distribution is similar to the Gaussian/normal distribution, but is sharper at the peak and has fatter tails. It represents the difference between two independent, identically distributed exponential random variables.  Note New code should use the laplace method of a default_rng() instance instead; please see the Quick Start.   Parameters

locfloat or array_like of floats, optional

The position, \(\mu\), of the distribution peak. Default is 0.
scalefloat or array_like of floats, optional

\(\lambda\), the exponential decay. Default is 1. Must be non- negative.
sizeint 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 loc and scale are both scalars. Otherwise, np.broadcast(loc, scale).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized Laplace distribution.      See also  Generator.laplace

which should be used for new code.    Notes It has the probability density function  \[f(x; \mu, \lambda) = \frac{1}{2\lambda} \exp\left(-\frac{|x - \mu|}{\lambda}\right).\] The first law of Laplace, from 1774, states that the frequency of an error can be expressed as an exponential function of the absolute magnitude of the error, which leads to the Laplace distribution. For many problems in economics and health sciences, this distribution seems to model the data better than the standard Gaussian distribution. References  1
Abramowitz, M. and Stegun, I. A. (Eds.). “Handbook of Mathematical Functions with Formulas, Graphs, and Mathematical Tables, 9th printing,” New York: Dover, 1972.  2
Kotz, Samuel, et. al. “The Laplace Distribution and Generalizations, ” Birkhauser, 2001.  3
Weisstein, Eric W. “Laplace Distribution.” From MathWorld–A Wolfram Web Resource. http://mathworld.wolfram.com/LaplaceDistribution.html  4
Wikipedia, “Laplace distribution”, https://en.wikipedia.org/wiki/Laplace_distribution   Examples Draw samples from the distribution >>> loc, scale = 0., 1.
>>> s = np.random.laplace(loc, scale, 1000)
 Display the histogram of the samples, along with the probability density function: >>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(s, 30, density=True)
>>> x = np.arange(-8., 8., .01)
>>> pdf = np.exp(-abs(x-loc)/scale)/(2.*scale)
>>> plt.plot(x, pdf)
 Plot Gaussian for comparison: >>> g = (1/(scale * np.sqrt(2 * np.pi)) *
...      np.exp(-(x - loc)**2 / (2 * scale**2)))
>>> plt.plot(x,g)


numpy.random.RandomState.logistic method   random.RandomState.logistic(loc=0.0, scale=1.0, size=None)

Draw samples from a logistic distribution. Samples are drawn from a logistic distribution with specified parameters, loc (location or mean, also median), and scale (>0).  Note New code should use the logistic method of a default_rng() instance instead; please see the Quick Start.   Parameters

locfloat or array_like of floats, optional

Parameter of the distribution. Default is 0.
scalefloat or array_like of floats, optional

Parameter of the distribution. Must be non-negative. Default is 1.
sizeint 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 loc and scale are both scalars. Otherwise, np.broadcast(loc, scale).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized logistic distribution.      See also  scipy.stats.logistic

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

which should be used for new code.    Notes The probability density for the Logistic distribution is  \[P(x) = P(x) = \frac{e^{-(x-\mu)/s}}{s(1+e^{-(x-\mu)/s})^2},\] where \(\mu\) = location and \(s\) = scale. The Logistic distribution is used in Extreme Value problems where it can act as a mixture of Gumbel distributions, in Epidemiology, and by the World Chess Federation (FIDE) where it is used in the Elo ranking system, assuming the performance of each player is a logistically distributed random variable. References  1
Reiss, R.-D. and Thomas M. (2001), “Statistical Analysis of Extreme Values, from Insurance, Finance, Hydrology and Other Fields,” Birkhauser Verlag, Basel, pp 132-133.  2
Weisstein, Eric W. “Logistic Distribution.” From MathWorld–A Wolfram Web Resource. http://mathworld.wolfram.com/LogisticDistribution.html  3
Wikipedia, “Logistic-distribution”, https://en.wikipedia.org/wiki/Logistic_distribution   Examples Draw samples from the distribution: >>> loc, scale = 10, 1
>>> s = np.random.logistic(loc, scale, 10000)
>>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(s, bins=50)
 # plot against distribution >>> def logist(x, loc, scale):
...     return np.exp((loc-x)/scale)/(scale*(1+np.exp((loc-x)/scale))**2)
>>> lgst_val = logist(bins, loc, scale)
>>> plt.plot(bins, lgst_val * count.max() / lgst_val.max())
>>> plt.show()


numpy.random.RandomState.lognormal method   random.RandomState.lognormal(mean=0.0, sigma=1.0, size=None)

Draw samples from a log-normal distribution. Draw samples from a log-normal distribution with specified mean, standard deviation, and array shape. Note that the mean and standard deviation are not the values for the distribution itself, but of the underlying normal distribution it is derived from.  Note New code should use the lognormal method of a default_rng() instance instead; please see the Quick Start.   Parameters

meanfloat or array_like of floats, optional

Mean value of the underlying normal distribution. Default is 0.
sigmafloat or array_like of floats, optional

Standard deviation of the underlying normal distribution. Must be non-negative. Default is 1.
sizeint 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 mean and sigma are both scalars. Otherwise, np.broadcast(mean, sigma).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized log-normal distribution.      See also  scipy.stats.lognorm

probability density function, distribution, cumulative density function, etc.  Generator.lognormal

which should be used for new code.    Notes A variable x has a log-normal distribution if log(x) is normally distributed. The probability density function for the log-normal distribution is:  \[p(x) = \frac{1}{\sigma x \sqrt{2\pi}} e^{(-\frac{(ln(x)-\mu)^2}{2\sigma^2})}\] where \(\mu\) is the mean and \(\sigma\) is the standard deviation of the normally distributed logarithm of the variable. A log-normal distribution results if a random variable is the product of a large number of independent, identically-distributed variables in the same way that a normal distribution results if the variable is the sum of a large number of independent, identically-distributed variables. References  1
Limpert, E., Stahel, W. A., and Abbt, M., “Log-normal Distributions across the Sciences: Keys and Clues,” BioScience, Vol. 51, No. 5, May, 2001. https://stat.ethz.ch/~stahel/lognormal/bioscience.pdf  2
Reiss, R.D. and Thomas, M., “Statistical Analysis of Extreme Values,” Basel: Birkhauser Verlag, 2001, pp. 31-32.   Examples Draw samples from the distribution: >>> mu, sigma = 3., 1. # mean and standard deviation
>>> s = np.random.lognormal(mu, sigma, 1000)
 Display the histogram of the samples, along with the probability density function: >>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(s, 100, density=True, align='mid')
 >>> x = np.linspace(min(bins), max(bins), 10000)
>>> pdf = (np.exp(-(np.log(x) - mu)**2 / (2 * sigma**2))
...        / (x * sigma * np.sqrt(2 * np.pi)))
 >>> plt.plot(x, pdf, linewidth=2, color='r')
>>> plt.axis('tight')
>>> plt.show()
    Demonstrate that taking the products of random samples from a uniform distribution can be fit well by a log-normal probability density function. >>> # Generate a thousand samples: each is the product of 100 random
>>> # values, drawn from a normal distribution.
>>> b = []
>>> for i in range(1000):
...    a = 10. + np.random.standard_normal(100)
...    b.append(np.product(a))
 >>> b = np.array(b) / np.min(b) # scale values to be positive
>>> count, bins, ignored = plt.hist(b, 100, density=True, align='mid')
>>> sigma = np.std(np.log(b))
>>> mu = np.mean(np.log(b))
 >>> x = np.linspace(min(bins), max(bins), 10000)
>>> pdf = (np.exp(-(np.log(x) - mu)**2 / (2 * sigma**2))
...        / (x * sigma * np.sqrt(2 * np.pi)))
 >>> plt.plot(x, pdf, color='r', linewidth=2)
>>> plt.show()


numpy.random.RandomState.logseries method   random.RandomState.logseries(p, size=None)

Draw samples from a logarithmic series distribution. Samples are drawn from a log series distribution with specified shape parameter, 0 < p < 1.  Note New code should use the logseries method of a default_rng() instance instead; please see the Quick Start.   Parameters

pfloat or array_like of floats

Shape parameter for the distribution. Must be in the range (0, 1).
sizeint 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 p is a scalar. Otherwise, np.array(p).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized logarithmic series distribution.      See also  scipy.stats.logser

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

which should be used for new code.    Notes The probability density for the Log Series distribution is  \[P(k) = \frac{-p^k}{k \ln(1-p)},\] where p = probability. The log series distribution is frequently used to represent species richness and occurrence, first proposed by Fisher, Corbet, and Williams in 1943 [2]. It may also be used to model the numbers of occupants seen in cars [3]. References  1
Buzas, Martin A.; Culver, Stephen J., Understanding regional species diversity through the log series distribution of occurrences: BIODIVERSITY RESEARCH Diversity & Distributions, Volume 5, Number 5, September 1999 , pp. 187-195(9).  2
Fisher, R.A,, A.S. Corbet, and C.B. Williams. 1943. The relation between the number of species and the number of individuals in a random sample of an animal population. Journal of Animal Ecology, 12:42-58.  3
D. J. Hand, F. Daly, D. Lunn, E. Ostrowski, A Handbook of Small Data Sets, CRC Press, 1994.  4
Wikipedia, “Logarithmic distribution”, https://en.wikipedia.org/wiki/Logarithmic_distribution   Examples Draw samples from the distribution: >>> a = .6
>>> s = np.random.logseries(a, 10000)
>>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(s)
 # plot against distribution >>> def logseries(k, p):
...     return -p**k/(k*np.log(1-p))
>>> plt.plot(bins, logseries(bins, a)*count.max()/
...          logseries(bins, a).max(), 'r')
>>> plt.show()


numpy.random.RandomState.multinomial method   random.RandomState.multinomial(n, pvals, size=None)

Draw samples from a multinomial distribution. The multinomial distribution is a multivariate generalization of the binomial distribution. Take an experiment with one of p possible outcomes. An example of such an experiment is throwing a dice, where the outcome can be 1 through 6. Each sample drawn from the distribution represents n such experiments. Its values, X_i = [X_0, X_1, ..., X_p], represent the number of times the outcome was i.  Note New code should use the multinomial method of a default_rng() instance instead; please see the Quick Start.   Parameters

nint

Number of experiments.
pvalssequence of floats, length p

Probabilities of each of the p different outcomes. These must sum to 1 (however, the last element is always assumed to account for the remaining probability, as long as sum(pvals[:-1]) <= 1).
sizeint or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn. Default is None, in which case a single value is returned.    Returns

outndarray

The drawn samples, of shape size, if that was provided. If not, the shape is (N,). In other words, each entry out[i,j,...,:] is an N-dimensional value drawn from the distribution.      See also  Generator.multinomial

which should be used for new code.    Examples Throw a dice 20 times: >>> np.random.multinomial(20, [1/6.]*6, size=1)
array([[4, 1, 7, 5, 2, 1]]) # random
 It landed 4 times on 1, once on 2, etc. Now, throw the dice 20 times, and 20 times again: >>> np.random.multinomial(20, [1/6.]*6, size=2)
array([[3, 4, 3, 3, 4, 3], # random
       [2, 4, 3, 4, 0, 7]])
 For the first run, we threw 3 times 1, 4 times 2, etc. For the second, we threw 2 times 1, 4 times 2, etc. A loaded die is more likely to land on number 6: >>> np.random.multinomial(100, [1/7.]*5 + [2/7.])
array([11, 16, 14, 17, 16, 26]) # random
 The probability inputs should be normalized. As an implementation detail, the value of the last entry is ignored and assumed to take up any leftover probability mass, but this should not be relied on. A biased coin which has twice as much weight on one side as on the other should be sampled like so: >>> np.random.multinomial(100, [1.0 / 3, 2.0 / 3])  # RIGHT
array([38, 62]) # random
 not like: >>> np.random.multinomial(100, [1.0, 2.0])  # WRONG
Traceback (most recent call last):
ValueError: pvals < 0, pvals > 1 or pvals contains NaNs


numpy.random.RandomState.multivariate_normal method   random.RandomState.multivariate_normal(mean, cov, size=None, check_valid='warn', tol=1e-8)

Draw random samples from a multivariate normal distribution. The multivariate normal, multinormal or Gaussian distribution is a generalization of the one-dimensional normal distribution to higher dimensions. Such a distribution is specified by its mean and covariance matrix. These parameters are analogous to the mean (average or “center”) and variance (standard deviation, or “width,” squared) of the one-dimensional normal distribution.  Note New code should use the multivariate_normal method of a default_rng() instance instead; please see the Quick Start.   Parameters

mean1-D array_like, of length N

Mean of the N-dimensional distribution.
cov2-D array_like, of shape (N, N)

Covariance matrix of the distribution. It must be symmetric and positive-semidefinite for proper sampling.
sizeint or tuple of ints, optional

Given a shape of, for example, (m,n,k), m*n*k samples are generated, and packed in an m-by-n-by-k arrangement. Because each sample is N-dimensional, the output shape is (m,n,k,N). If no shape is specified, a single (N-D) sample is returned.
check_valid{ ‘warn’, ‘raise’, ‘ignore’ }, optional

Behavior when the covariance matrix is not positive semidefinite.
tolfloat, optional

Tolerance when checking the singular values in covariance matrix. cov is cast to double before the check.    Returns

outndarray

The drawn samples, of shape size, if that was provided. If not, the shape is (N,). In other words, each entry out[i,j,...,:] is an N-dimensional value drawn from the distribution.      See also  Generator.multivariate_normal

which should be used for new code.    Notes The mean is a coordinate in N-dimensional space, which represents the location where samples are most likely to be generated. This is analogous to the peak of the bell curve for the one-dimensional or univariate normal distribution. Covariance indicates the level to which two variables vary together. From the multivariate normal distribution, we draw N-dimensional samples, \(X = [x_1, x_2, ... x_N]\). The covariance matrix element \(C_{ij}\) is the covariance of \(x_i\) and \(x_j\). The element \(C_{ii}\) is the variance of \(x_i\) (i.e. its “spread”). Instead of specifying the full covariance matrix, popular approximations include:  Spherical covariance (cov is a multiple of the identity matrix) Diagonal covariance (cov has non-negative elements, and only on the diagonal)  This geometrical property can be seen in two dimensions by plotting generated data-points: >>> mean = [0, 0]
>>> cov = [[1, 0], [0, 100]]  # diagonal covariance
 Diagonal covariance means that points are oriented along x or y-axis: >>> import matplotlib.pyplot as plt
>>> x, y = np.random.multivariate_normal(mean, cov, 5000).T
>>> plt.plot(x, y, 'x')
>>> plt.axis('equal')
>>> plt.show()
 Note that the covariance matrix must be positive semidefinite (a.k.a. nonnegative-definite). Otherwise, the behavior of this method is undefined and backwards compatibility is not guaranteed. References  1
Papoulis, A., “Probability, Random Variables, and Stochastic Processes,” 3rd ed., New York: McGraw-Hill, 1991.  2
Duda, R. O., Hart, P. E., and Stork, D. G., “Pattern Classification,” 2nd ed., New York: Wiley, 2001.   Examples >>> mean = (1, 2)
>>> cov = [[1, 0], [0, 1]]
>>> x = np.random.multivariate_normal(mean, cov, (3, 3))
>>> x.shape
(3, 3, 2)
 The following is probably true, given that 0.6 is roughly twice the standard deviation: >>> list((x[0,0,:] - mean) < 0.6)
[True, True] # random


numpy.random.RandomState.negative_binomial method   random.RandomState.negative_binomial(n, p, size=None)

Draw samples from a negative binomial distribution. Samples are drawn from a negative binomial distribution with specified parameters, n successes and p probability of success where n is > 0 and p is in the interval [0, 1].  Note New code should use the negative_binomial method of a default_rng() instance instead; please see the Quick Start.   Parameters

nfloat or array_like of floats

Parameter of the distribution, > 0.
pfloat or array_like of floats

Parameter of the distribution, >= 0 and <=1.
sizeint 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 n and p are both scalars. Otherwise, np.broadcast(n, p).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized negative binomial distribution, where each sample is equal to N, the number of failures that occurred before a total of n successes was reached.      See also  Generator.negative_binomial

which should be used for new code.    Notes The probability mass function of the negative binomial distribution is  \[P(N;n,p) = \frac{\Gamma(N+n)}{N!\Gamma(n)}p^{n}(1-p)^{N},\] where \(n\) is the number of successes, \(p\) is the probability of success, \(N+n\) is the number of trials, and \(\Gamma\) is the gamma function. When \(n\) is an integer, \(\frac{\Gamma(N+n)}{N!\Gamma(n)} = \binom{N+n-1}{N}\), which is the more common form of this term in the the pmf. The negative binomial distribution gives the probability of N failures given n successes, with a success on the last trial. If one throws a die repeatedly until the third time a “1” appears, then the probability distribution of the number of non-“1”s that appear before the third “1” is a negative binomial distribution. References  1
Weisstein, Eric W. “Negative Binomial Distribution.” From MathWorld–A Wolfram Web Resource. http://mathworld.wolfram.com/NegativeBinomialDistribution.html  2
Wikipedia, “Negative binomial distribution”, https://en.wikipedia.org/wiki/Negative_binomial_distribution   Examples Draw samples from the distribution: A real world example. A company drills wild-cat oil exploration wells, each with an estimated probability of success of 0.1. What is the probability of having one success for each successive well, that is what is the probability of a single success after drilling 5 wells, after 6 wells, etc.? >>> s = np.random.negative_binomial(1, 0.1, 100000)
>>> for i in range(1, 11):
...    probability = sum(s<i) / 100000.
...    print(i, "wells drilled, probability of one success =", probability)


numpy.random.RandomState.noncentral_chisquare method   random.RandomState.noncentral_chisquare(df, nonc, size=None)

Draw samples from a noncentral chi-square distribution. The noncentral \(\chi^2\) distribution is a generalization of the \(\chi^2\) distribution.  Note New code should use the noncentral_chisquare method of a default_rng() instance instead; please see the Quick Start.   Parameters

dffloat or array_like of floats

Degrees of freedom, must be > 0.  Changed in version 1.10.0: Earlier NumPy versions required dfnum > 1.
noncfloat or array_like of floats

Non-centrality, must be non-negative.
sizeint 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

outndarray or scalar

Drawn samples from the parameterized noncentral chi-square distribution.      See also  Generator.noncentral_chisquare

which should be used for new code.    Notes The probability density function for the noncentral Chi-square distribution is  \[P(x;df,nonc) = \sum^{\infty}_{i=0} \frac{e^{-nonc/2}(nonc/2)^{i}}{i!} P_{Y_{df+2i}}(x),\] where \(Y_{q}\) is the Chi-square with q degrees of freedom. References  1
Wikipedia, “Noncentral chi-squared distribution” https://en.wikipedia.org/wiki/Noncentral_chi-squared_distribution   Examples Draw values from the distribution and plot the histogram >>> import matplotlib.pyplot as plt
>>> values = plt.hist(np.random.noncentral_chisquare(3, 20, 100000),
...                   bins=200, density=True)
>>> plt.show()
    Draw values from a noncentral chisquare with very small noncentrality, and compare to a chisquare. >>> plt.figure()
>>> values = plt.hist(np.random.noncentral_chisquare(3, .0000001, 100000),
...                   bins=np.arange(0., 25, .1), density=True)
>>> values2 = plt.hist(np.random.chisquare(3, 100000),
...                    bins=np.arange(0., 25, .1), density=True)
>>> plt.plot(values[1][0:-1], values[0]-values2[0], 'ob')
>>> plt.show()
    Demonstrate how large values of non-centrality lead to a more symmetric distribution. >>> plt.figure()
>>> values = plt.hist(np.random.noncentral_chisquare(3, 20, 100000),
...                   bins=200, density=True)
>>> plt.show()


numpy.random.RandomState.noncentral_f method   random.RandomState.noncentral_f(dfnum, dfden, nonc, size=None)

Draw samples from the noncentral F distribution. Samples are drawn from an F distribution with specified parameters, dfnum (degrees of freedom in numerator) and dfden (degrees of freedom in denominator), where both parameters > 1. nonc is the non-centrality parameter.  Note New code should use the noncentral_f method of a default_rng() instance instead; please see the Quick Start.   Parameters

dfnumfloat or array_like of floats

Numerator degrees of freedom, must be > 0.  Changed in version 1.14.0: Earlier NumPy versions required dfnum > 1.
dfdenfloat or array_like of floats

Denominator degrees of freedom, must be > 0.
noncfloat or array_like of floats

Non-centrality parameter, the sum of the squares of the numerator means, must be >= 0.
sizeint 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 dfnum, dfden, and nonc are all scalars. Otherwise, np.broadcast(dfnum, dfden, nonc).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized noncentral Fisher distribution.      See also  Generator.noncentral_f

which should be used for new code.    Notes When calculating the power of an experiment (power = probability of rejecting the null hypothesis when a specific alternative is true) the non-central F statistic becomes important. When the null hypothesis is true, the F statistic follows a central F distribution. When the null hypothesis is not true, then it follows a non-central F statistic. References  1
Weisstein, Eric W. “Noncentral F-Distribution.” From MathWorld–A Wolfram Web Resource. http://mathworld.wolfram.com/NoncentralF-Distribution.html  2
Wikipedia, “Noncentral F-distribution”, https://en.wikipedia.org/wiki/Noncentral_F-distribution   Examples In a study, testing for a specific alternative to the null hypothesis requires use of the Noncentral F distribution. We need to calculate the area in the tail of the distribution that exceeds the value of the F distribution for the null hypothesis. We’ll plot the two probability distributions for comparison. >>> dfnum = 3 # between group deg of freedom
>>> dfden = 20 # within groups degrees of freedom
>>> nonc = 3.0
>>> nc_vals = np.random.noncentral_f(dfnum, dfden, nonc, 1000000)
>>> NF = np.histogram(nc_vals, bins=50, density=True)
>>> c_vals = np.random.f(dfnum, dfden, 1000000)
>>> F = np.histogram(c_vals, bins=50, density=True)
>>> import matplotlib.pyplot as plt
>>> plt.plot(F[1][1:], F[0])
>>> plt.plot(NF[1][1:], NF[0])
>>> plt.show()


numpy.random.RandomState.normal method   random.RandomState.normal(loc=0.0, scale=1.0, size=None)

Draw random samples from a normal (Gaussian) distribution. The probability density function of the normal distribution, first derived by De Moivre and 200 years later by both Gauss and Laplace independently [2], is often called the bell curve because of its characteristic shape (see the example below). The normal distributions occurs often in nature. For example, it describes the commonly occurring distribution of samples influenced by a large number of tiny, random disturbances, each with its own unique distribution [2].  Note New code should use the normal method of a default_rng() instance instead; please see the Quick Start.   Parameters

locfloat or array_like of floats

Mean (“centre”) of the distribution.
scalefloat or array_like of floats

Standard deviation (spread or “width”) of the distribution. Must be non-negative.
sizeint 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 loc and scale are both scalars. Otherwise, np.broadcast(loc, scale).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized normal distribution.      See also  scipy.stats.norm

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

which should be used for new code.    Notes The probability density for the Gaussian distribution is  \[p(x) = \frac{1}{\sqrt{ 2 \pi \sigma^2 }} e^{ - \frac{ (x - \mu)^2 } {2 \sigma^2} },\] where \(\mu\) is the mean and \(\sigma\) the standard deviation. The square of the standard deviation, \(\sigma^2\), is called the variance. The function has its peak at the mean, and its “spread” increases with the standard deviation (the function reaches 0.607 times its maximum at \(x + \sigma\) and \(x - \sigma\) [2]). This implies that normal is more likely to return samples lying close to the mean, rather than those far away. References  1
Wikipedia, “Normal distribution”, https://en.wikipedia.org/wiki/Normal_distribution
2(1,2,3)

P. R. Peebles Jr., “Central Limit Theorem” in “Probability, Random Variables and Random Signal Principles”, 4th ed., 2001, pp. 51, 51, 125.   Examples Draw samples from the distribution: >>> mu, sigma = 0, 0.1 # mean and standard deviation
>>> s = np.random.normal(mu, sigma, 1000)
 Verify the mean and the variance: >>> abs(mu - np.mean(s))
0.0  # may vary
 >>> abs(sigma - np.std(s, ddof=1))
0.1  # may vary
 Display the histogram of the samples, along with the probability density function: >>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(s, 30, density=True)
>>> plt.plot(bins, 1/(sigma * np.sqrt(2 * np.pi)) *
...                np.exp( - (bins - mu)**2 / (2 * sigma**2) ),
...          linewidth=2, color='r')
>>> plt.show()
    Two-by-four array of samples from N(3, 6.25): >>> np.random.normal(3, 2.5, size=(2, 4))
array([[-4.49401501,  4.00950034, -1.81814867,  7.29718677],   # random
       [ 0.39924804,  4.68456316,  4.99394529,  4.84057254]])  # random


numpy.random.RandomState.pareto method   random.RandomState.pareto(a, size=None)

Draw samples from a Pareto II or Lomax distribution with specified shape. The Lomax or Pareto II distribution is a shifted Pareto distribution. The classical Pareto distribution can be obtained from the Lomax distribution by adding 1 and multiplying by the scale parameter m (see Notes). The smallest value of the Lomax distribution is zero while for the classical Pareto distribution it is mu, where the standard Pareto distribution has location mu = 1. Lomax can also be considered as a simplified version of the Generalized Pareto distribution (available in SciPy), with the scale set to one and the location set to zero. The Pareto distribution must be greater than zero, and is unbounded above. It is also known as the “80-20 rule”. In this distribution, 80 percent of the weights are in the lowest 20 percent of the range, while the other 20 percent fill the remaining 80 percent of the range.  Note New code should use the pareto method of a default_rng() instance instead; please see the Quick Start.   Parameters

afloat or array_like of floats

Shape of the distribution. Must be positive.
sizeint 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

outndarray or scalar

Drawn samples from the parameterized Pareto distribution.      See also  scipy.stats.lomax

probability density function, distribution or cumulative density function, etc.  scipy.stats.genpareto

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

which should be used for new code.    Notes The probability density for the Pareto distribution is  \[p(x) = \frac{am^a}{x^{a+1}}\] where \(a\) is the shape and \(m\) the scale. The Pareto distribution, named after the Italian economist Vilfredo Pareto, is a power law probability distribution useful in many real world problems. Outside the field of economics it is generally referred to as the Bradford distribution. Pareto developed the distribution to describe the distribution of wealth in an economy. It has also found use in insurance, web page access statistics, oil field sizes, and many other problems, including the download frequency for projects in Sourceforge [1]. It is one of the so-called “fat-tailed” distributions. References  1
Francis Hunt and Paul Johnson, On the Pareto Distribution of Sourceforge projects.  2
Pareto, V. (1896). Course of Political Economy. Lausanne.  3
Reiss, R.D., Thomas, M.(2001), Statistical Analysis of Extreme Values, Birkhauser Verlag, Basel, pp 23-30.  4
Wikipedia, “Pareto distribution”, https://en.wikipedia.org/wiki/Pareto_distribution   Examples Draw samples from the distribution: >>> a, m = 3., 2.  # shape and mode
>>> s = (np.random.pareto(a, 1000) + 1) * m
 Display the histogram of the samples, along with the probability density function: >>> import matplotlib.pyplot as plt
>>> count, bins, _ = plt.hist(s, 100, density=True)
>>> fit = a*m**a / bins**(a+1)
>>> plt.plot(bins, max(count)*fit/max(fit), linewidth=2, color='r')
>>> plt.show()


numpy.random.RandomState.permutation method   random.RandomState.permutation(x)

Randomly permute a sequence, or return a permuted range. If x is a multi-dimensional array, it is only shuffled along its first index.  Note New code should use the permutation method of a default_rng() instance instead; please see the Quick Start.   Parameters

xint or array_like

If x is an integer, randomly permute np.arange(x). If x is an array, make a copy and shuffle the elements randomly.    Returns

outndarray

Permuted sequence or array range.      See also  Generator.permutation

which should be used for new code.    Examples >>> np.random.permutation(10)
array([1, 7, 4, 3, 0, 9, 2, 5, 8, 6]) # random
 >>> np.random.permutation([1, 4, 9, 12, 15])
array([15,  1,  9,  4, 12]) # random
 >>> arr = np.arange(9).reshape((3, 3))
>>> np.random.permutation(arr)
array([[6, 7, 8], # random
       [0, 1, 2],
       [3, 4, 5]])


numpy.random.RandomState.poisson method   random.RandomState.poisson(lam=1.0, size=None)

Draw samples from a Poisson distribution. The Poisson distribution is the limit of the binomial distribution for large N.  Note New code should use the poisson method of a default_rng() instance instead; please see the Quick Start.   Parameters

lamfloat or array_like of floats

Expected number of events occurring in a fixed-time interval, must be >= 0. A sequence must be broadcastable over the requested size.
sizeint 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 lam is a scalar. Otherwise, np.array(lam).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized Poisson distribution.      See also  Generator.poisson

which should be used for new code.    Notes The Poisson distribution  \[f(k; \lambda)=\frac{\lambda^k e^{-\lambda}}{k!}\] For events with an expected separation \(\lambda\) the Poisson distribution \(f(k; \lambda)\) describes the probability of \(k\) events occurring within the observed interval \(\lambda\). Because the output is limited to the range of the C int64 type, a ValueError is raised when lam is within 10 sigma of the maximum representable value. References  1
Weisstein, Eric W. “Poisson Distribution.” From MathWorld–A Wolfram Web Resource. http://mathworld.wolfram.com/PoissonDistribution.html  2
Wikipedia, “Poisson distribution”, https://en.wikipedia.org/wiki/Poisson_distribution   Examples Draw samples from the distribution: >>> import numpy as np
>>> s = np.random.poisson(5, 10000)
 Display histogram of the sample: >>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(s, 14, density=True)
>>> plt.show()
    Draw each 100 values for lambda 100 and 500: >>> s = np.random.poisson(lam=(100., 500.), size=(100, 2))


numpy.random.RandomState.power method   random.RandomState.power(a, size=None)

Draws samples in [0, 1] from a power distribution with positive exponent a - 1. Also known as the power function distribution.  Note New code should use the power method of a default_rng() instance instead; please see the Quick Start.   Parameters

afloat or array_like of floats

Parameter of the distribution. Must be non-negative.
sizeint 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

outndarray or scalar

Drawn samples from the parameterized power distribution.    Raises
 ValueError

If a <= 0.      See also  Generator.power

which should be used for new code.    Notes The probability density function is  \[P(x; a) = ax^{a-1}, 0 \le x \le 1, a>0.\] The power function distribution is just the inverse of the Pareto distribution. It may also be seen as a special case of the Beta distribution. It is used, for example, in modeling the over-reporting of insurance claims. References  1
Christian Kleiber, Samuel Kotz, “Statistical size distributions in economics and actuarial sciences”, Wiley, 2003.  2
Heckert, N. A. and Filliben, James J. “NIST Handbook 148: Dataplot Reference Manual, Volume 2: Let Subcommands and Library Functions”, National Institute of Standards and Technology Handbook Series, June 2003. https://www.itl.nist.gov/div898/software/dataplot/refman2/auxillar/powpdf.pdf   Examples Draw samples from the distribution: >>> a = 5. # shape
>>> samples = 1000
>>> s = np.random.power(a, samples)
 Display the histogram of the samples, along with the probability density function: >>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(s, bins=30)
>>> x = np.linspace(0, 1, 100)
>>> y = a*x**(a-1.)
>>> normed_y = samples*np.diff(bins)[0]*y
>>> plt.plot(x, normed_y)
>>> plt.show()
    Compare the power function distribution to the inverse of the Pareto. >>> from scipy import stats
>>> rvs = np.random.power(5, 1000000)
>>> rvsp = np.random.pareto(5, 1000000)
>>> xx = np.linspace(0,1,100)
>>> powpdf = stats.powerlaw.pdf(xx,5)
 >>> plt.figure()
>>> plt.hist(rvs, bins=50, density=True)
>>> plt.plot(xx,powpdf,'r-')
>>> plt.title('np.random.power(5)')
 >>> plt.figure()
>>> plt.hist(1./(1.+rvsp), bins=50, density=True)
>>> plt.plot(xx,powpdf,'r-')
>>> plt.title('inverse of 1 + np.random.pareto(5)')
 >>> plt.figure()
>>> plt.hist(1./(1.+rvsp), bins=50, density=True)
>>> plt.plot(xx,powpdf,'r-')
>>> plt.title('inverse of stats.pareto(5)')


numpy.random.RandomState.rand method   random.RandomState.rand(d0, d1, ..., dn)

Random values in a given shape.  Note This is a convenience function for users porting code from Matlab, and wraps random_sample. That function takes a tuple to specify the size of the output, which is consistent with other NumPy functions like numpy.zeros and numpy.ones.  Create an array of the given shape and populate it with random samples from a uniform distribution over [0, 1).  Parameters

d0, d1, …, dnint, optional

The dimensions of the returned array, must be non-negative. If no argument is given a single Python float is returned.    Returns

outndarray, shape (d0, d1, ..., dn)

Random values.      See also  random
  Examples >>> np.random.rand(3,2)
array([[ 0.14022471,  0.96360618],  #random
       [ 0.37601032,  0.25528411],  #random
       [ 0.49313049,  0.94909878]]) #random


numpy.random.RandomState.randint method   random.RandomState.randint(low, high=None, size=None, dtype=int)

Return random integers from low (inclusive) to high (exclusive). Return random integers from the “discrete uniform” distribution of the specified dtype in the “half-open” interval [low, high). If high is None (the default), then results are from [0, low).  Note New code should use the integers method of a default_rng() instance instead; please see the Quick Start.   Parameters

lowint or array-like of ints

Lowest (signed) integers to be drawn from the distribution (unless high=None, in which case this parameter is one above the highest such integer).
highint or array-like of ints, optional

If provided, one above the largest (signed) integer to be drawn from the distribution (see above for behavior if high=None). If array-like, must contain integer values
sizeint or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn. Default is None, in which case a single value is returned.
dtypedtype, optional

Desired dtype of the result. Byteorder must be native. The default value is int.  New in version 1.11.0.     Returns

outint or ndarray of ints

size-shaped array of random integers from the appropriate distribution, or a single such random int if size not provided.      See also  random_integers

similar to randint, only for the closed interval [low, high], and 1 is the lowest value if high is omitted.  Generator.integers

which should be used for new code.    Examples >>> np.random.randint(2, size=10)
array([1, 0, 0, 0, 1, 1, 0, 0, 1, 0]) # random
>>> np.random.randint(1, size=10)
array([0, 0, 0, 0, 0, 0, 0, 0, 0, 0])
 Generate a 2 x 4 array of ints between 0 and 4, inclusive: >>> np.random.randint(5, size=(2, 4))
array([[4, 0, 2, 1], # random
       [3, 2, 2, 0]])
 Generate a 1 x 3 array with 3 different upper bounds >>> np.random.randint(1, [3, 5, 10])
array([2, 2, 9]) # random
 Generate a 1 by 3 array with 3 different lower bounds >>> np.random.randint([1, 5, 7], 10)
array([9, 8, 7]) # random
 Generate a 2 by 4 array using broadcasting with dtype of uint8 >>> np.random.randint([1, 3, 5, 7], [[10], [20]], dtype=np.uint8)
array([[ 8,  6,  9,  7], # random
       [ 1, 16,  9, 12]], dtype=uint8)


numpy.random.RandomState.randn method   random.RandomState.randn(d0, d1, ..., dn)

Return a sample (or samples) from the “standard normal” distribution.  Note This is a convenience function for users porting code from Matlab, and wraps standard_normal. That function takes a tuple to specify the size of the output, which is consistent with other NumPy functions like numpy.zeros and numpy.ones.   Note New code should use the standard_normal method of a default_rng() instance instead; please see the Quick Start.  If positive int_like arguments are provided, randn generates an array of shape (d0, d1, ..., dn), filled with random floats sampled from a univariate “normal” (Gaussian) distribution of mean 0 and variance 1. A single float randomly sampled from the distribution is returned if no argument is provided.  Parameters

d0, d1, …, dnint, optional

The dimensions of the returned array, must be non-negative. If no argument is given a single Python float is returned.    Returns

Zndarray or float

A (d0, d1, ..., dn)-shaped array of floating-point samples from the standard normal distribution, or a single such float if no parameters were supplied.      See also  standard_normal

Similar, but takes a tuple as its argument.  normal

Also accepts mu and sigma arguments.  Generator.standard_normal

which should be used for new code.    Notes For random samples from \(N(\mu, \sigma^2)\), use: sigma * np.random.randn(...) + mu Examples >>> np.random.randn()
2.1923875335537315  # random
 Two-by-four array of samples from N(3, 6.25): >>> 3 + 2.5 * np.random.randn(2, 4)
array([[-4.49401501,  4.00950034, -1.81814867,  7.29718677],   # random
       [ 0.39924804,  4.68456316,  4.99394529,  4.84057254]])  # random


numpy.random.RandomState.random_integers method   random.RandomState.random_integers(low, high=None, size=None)

Random integers of type np.int_ between low and high, inclusive. Return random integers of type np.int_ from the “discrete uniform” distribution in the closed interval [low, high]. If high is None (the default), then results are from [1, low]. The np.int_ type translates to the C long integer type and its precision is platform dependent. This function has been deprecated. Use randint instead.  Deprecated since version 1.11.0.   Parameters

lowint

Lowest (signed) integer to be drawn from the distribution (unless high=None, in which case this parameter is the highest such integer).
highint, optional

If provided, the largest (signed) integer to be drawn from the distribution (see above for behavior if high=None).
sizeint or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn. Default is None, in which case a single value is returned.    Returns

outint or ndarray of ints

size-shaped array of random integers from the appropriate distribution, or a single such random int if size not provided.      See also  randint

Similar to random_integers, only for the half-open interval [low, high), and 0 is the lowest value if high is omitted.    Notes To sample from N evenly spaced floating-point numbers between a and b, use: a + (b - a) * (np.random.random_integers(N) - 1) / (N - 1.)
 Examples >>> np.random.random_integers(5)
4 # random
>>> type(np.random.random_integers(5))
<class 'numpy.int64'>
>>> np.random.random_integers(5, size=(3,2))
array([[5, 4], # random
       [3, 3],
       [4, 5]])
 Choose five random numbers from the set of five evenly-spaced numbers between 0 and 2.5, inclusive (i.e., from the set \({0, 5/8, 10/8, 15/8, 20/8}\)): >>> 2.5 * (np.random.random_integers(5, size=(5,)) - 1) / 4.
array([ 0.625,  1.25 ,  0.625,  0.625,  2.5  ]) # random
 Roll two six sided dice 1000 times and sum the results: >>> d1 = np.random.random_integers(1, 6, 1000)
>>> d2 = np.random.random_integers(1, 6, 1000)
>>> dsums = d1 + d2
 Display results as a histogram: >>> import matplotlib.pyplot as plt
>>> count, bins, ignored = plt.hist(dsums, 11, density=True)
>>> plt.show()


numpy.random.RandomState.random_sample method   random.RandomState.random_sample(size=None)

Return random floats in the half-open interval [0.0, 1.0). Results are from the “continuous uniform” distribution over the stated interval. To sample \(Unif[a, b), b > a\) multiply the output of random_sample by (b-a) and add a: (b - a) * random_sample() + a
  Note New code should use the random method of a default_rng() instance instead; please see the Quick Start.   Parameters

sizeint or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn. Default is None, in which case a single value is returned.    Returns

outfloat or ndarray of floats

Array of random floats of shape size (unless size=None, in which case a single float is returned).      See also  Generator.random

which should be used for new code.    Examples >>> np.random.random_sample()
0.47108547995356098 # random
>>> type(np.random.random_sample())
<class 'float'>
>>> np.random.random_sample((5,))
array([ 0.30220482,  0.86820401,  0.1654503 ,  0.11659149,  0.54323428]) # random
 Three-by-two array of random numbers from [-5, 0): >>> 5 * np.random.random_sample((3, 2)) - 5
array([[-3.99149989, -0.52338984], # random
       [-2.99091858, -0.79479508],
       [-1.23204345, -1.75224494]])


numpy.random.RandomState.rayleigh method   random.RandomState.rayleigh(scale=1.0, size=None)

Draw samples from a Rayleigh distribution. The \(\chi\) and Weibull distributions are generalizations of the Rayleigh.  Note New code should use the rayleigh method of a default_rng() instance instead; please see the Quick Start.   Parameters

scalefloat or array_like of floats, optional

Scale, also equals the mode. Must be non-negative. Default is 1.
sizeint 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 scale is a scalar. Otherwise, np.array(scale).size samples are drawn.    Returns

outndarray or scalar

Drawn samples from the parameterized Rayleigh distribution.      See also  Generator.rayleigh

which should be used for new code.    Notes The probability density function for the Rayleigh distribution is  \[P(x;scale) = \frac{x}{scale^2}e^{\frac{-x^2}{2 \cdotp scale^2}}\] The Rayleigh distribution would arise, for example, if the East and North components of the wind velocity had identical zero-mean Gaussian distributions. Then the wind speed would have a Rayleigh distribution. References  1
Brighton Webs Ltd., “Rayleigh Distribution,” https://web.archive.org/web/20090514091424/http://brighton-webs.co.uk:80/distributions/rayleigh.asp  2
Wikipedia, “Rayleigh distribution” https://en.wikipedia.org/wiki/Rayleigh_distribution   Examples Draw values from the distribution and plot the histogram >>> from matplotlib.pyplot import hist
>>> values = hist(np.random.rayleigh(3, 100000), bins=200, density=True)
 Wave heights tend to follow a Rayleigh distribution. If the mean wave height is 1 meter, what fraction of waves are likely to be larger than 3 meters? >>> meanvalue = 1
>>> modevalue = np.sqrt(2 / np.pi) * meanvalue
>>> s = np.random.rayleigh(modevalue, 1000000)
 The percentage of waves larger than 3 meters is: >>> 100.*sum(s>3)/1000000.
0.087300000000000003 # random


numpy.random.RandomState.seed method   random.RandomState.seed(self, seed=None)

Reseed a legacy MT19937 BitGenerator Notes This is a convenience, legacy function. The best practice is to not reseed a BitGenerator, rather to recreate a new one. This method is here for legacy reasons. This example demonstrates best practice. >>> from numpy.random import MT19937
>>> from numpy.random import RandomState, SeedSequence
>>> rs = RandomState(MT19937(SeedSequence(123456789)))
# Later, you want to restart the stream
>>> rs = RandomState(MT19937(SeedSequence(987654321)))


numpy.random.RandomState.set_state method   random.RandomState.set_state(state)

Set the internal state of the generator from a tuple. For use if one has reason to manually (re-)set the internal state of the bit generator used by the RandomState instance. By default, RandomState uses the “Mersenne Twister”[1] pseudo-random number generating algorithm.  Parameters

state{tuple(str, ndarray of 624 uints, int, int, float), dict}

The state tuple has the following items:  the string ‘MT19937’, specifying the Mersenne Twister algorithm. a 1-D array of 624 unsigned integers keys. an integer pos. an integer has_gauss. a float cached_gaussian.  If state is a dictionary, it is directly set using the BitGenerators state property.    Returns

outNone

Returns ‘None’ on success.      See also  get_state
  Notes set_state and get_state are not needed to work with any of the random distributions in NumPy. If the internal state is manually altered, the user should know exactly what he/she is doing. For backwards compatibility, the form (str, array of 624 uints, int) is also accepted although it is missing some information about the cached Gaussian value: state = ('MT19937', keys, pos). References  1
M. Matsumoto and T. Nishimura, “Mersenne Twister: A 623-dimensionally equidistributed uniform pseudorandom number generator,” ACM Trans. on Modeling and Computer Simulation, Vol. 8, No. 1, pp. 3-30, Jan. 1998.