nlcpy.spacing

nlcpy.spacing = <ufunc 'nlcpy_spacing'>

Returns the distance between x and the nearest adjacent number, element-wise.

Parameters

xarray_like

Input an array or a scalar.

outndarray or None, 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.

wherearray_like, 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 section Optional Keyword Arguments.

Returns

yndarray

The spacing of values of x. If x is a scalar, this function returns the result as a 0-dimension ndarray.

Note

It can be considered as a generalization of EPS: nlcpy.spacing(vp.float64(1)) == nlcpy.finfo(vp.float64).eps, and there should not be any representable number between x + spacing(x) and x for any finite x. Spacing of +- inf and NaN is NaN.

Examples

>>> import nlcpy as vp
>>> vp.spacing(1) == vp.finfo(vp.float64).eps
array(True)