dask 2021.10.0

NotesParametersReturns
wald(self, mean, scale, size=None, chunks='auto', **kwargs)

This docstring was copied from numpy.random.mtrand.RandomState.wald.

Some inconsistencies with the Dask version may exist.

As the scale approaches infinity, the distribution becomes more like a Gaussian. Some references claim that the Wald is an inverse Gaussian with mean equal to 1, but this is by no means universal.

The inverse Gaussian distribution was first studied in relationship to Brownian motion. In 1956 M.C.K. Tweedie used the name inverse Gaussian because there is an inverse relationship between the time to cover a unit distance and distance covered in unit time.

note

New code should use the wald method of a default_rng() instance instead; please see the :None:ref:`random-quick-start`.

Notes

The probability density function for the Wald distribution is

$$P(x;mean,scale) = \sqrt{\frac{scale}{2\pi x^3}}e^\frac{-scale(x-mean)^2}{2\cdotp mean^2x}$$

As noted above the inverse Gaussian distribution first arise from attempts to model Brownian motion. It is also a competitor to the Weibull for use in reliability modeling and modeling stock returns and interest rate processes.

Parameters

mean : float or array_like of floats

Distribution mean, must be > 0.

scale : float or array_like of floats

Scale parameter, must be > 0.

size : int or tuple of ints, optional

Output shape. If the given shape is, e.g., (m, n, k) , then m * n * k samples are drawn. If size is None (default), a single value is returned if mean and scale are both scalars. Otherwise, np.broadcast(mean, scale).size samples are drawn.

Returns

out : ndarray or scalar

Drawn samples from the parameterized Wald distribution.

Draw samples from a Wald, or inverse Gaussian, distribution.

See Also

Generator.wald

which should be used for new code.

Examples

Draw values from the distribution and plot the histogram:

This example is valid syntax, but we were not able to check execution
>>> import matplotlib.pyplot as plt  # doctest: +SKIP
... h = plt.hist(np.random.wald(3, 2, 100000), bins=200, density=True) # doctest: +SKIP
... plt.show() # doctest: +SKIP
See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /dask/array/random.py#437
type: <class 'function'>
Commit: