nums.numpy.spacing

nums.numpy.spacing(x, out=None, where=True, **kwargs)

Return the distance between x and the nearest adjacent number.

This docstring was copied from numpy.spacing.

Some inconsistencies with the NumS version may exist.

Parameters

• x (BlockArray) – Values to find the spacing of.

• out (BlockArray, None, or optional) – A location into which the result is stored. If provided, it must have a shape that the inputs broadcast to. If not provided or None, a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs.

• where (BlockArray, optional) – This condition is broadcast over the input. At locations where the condition is True, the out array will be set to the ufunc result. Elsewhere, the out array will retain its original value. Note that if an uninitialized out array is created via the default out=None, locations within it where the condition is False will remain uninitialized.

• **kwargs – For other keyword-only arguments, see the ufunc docs.

Returns

out – The spacing of values of x.

Return type

BlockArray or scalar