allclose(arr1, arr2, rtol=1e-05, atol=1e-08, equal_nan=False)

This docstring was copied from numpy.allclose.

Some inconsistencies with the Dask version may exist.

The tolerance values are positive, typically very small numbers. The relative difference (:None:None:`rtol` * abs(b)) and the absolute difference :None:None:`atol` are added together to compare against the absolute difference between a and b.

NaNs are treated as equal if they are in the same place and if equal_nan=True . Infs are treated as equal if they are in the same place and of the same sign in both arrays.

Notes

If the following equation is element-wise True, then allclose returns True.

absolute(a - b) <= (:None:None:`atol` + :None:None:`rtol` * absolute(b))

The above equation is not symmetric in a and b, so that allclose(a, b) might be different from allclose(b, a) in some rare cases.

The comparison of a and b uses standard broadcasting, which means that a and b need not have the same shape in order for allclose(a, b) to evaluate to True. The same is true for equal but not :None:None:`array_equal`.

allclose is not defined for non-numeric data types. :None:None:`bool` is considered a numeric data-type for this purpose.

Parameters

a, b : array_like

Input arrays to compare.

rtol : float

The relative tolerance parameter (see Notes).

atol : float

The absolute tolerance parameter (see Notes).

equal_nan : bool

Whether to compare NaN's as equal. If True, NaN's in a will be considered equal to NaN's in b in the output array.

versionadded

Returns

allclose : bool

Returns True if the two arrays are equal within the given tolerance; False otherwise.

Returns True if two arrays are element-wise equal within a tolerance.

See Also

all

any

equal

isclose

Examples

This example is valid syntax, but we were not able to check execution

>>> np.allclose([1e10,1e-7], [1.00001e10,1e-8])  # doctest: +SKIP
False

This example is valid syntax, but we were not able to check execution

>>> np.allclose([1e10,1e-8], [1.00001e10,1e-9])  # doctest: +SKIP
True

This example is valid syntax, but we were not able to check execution

>>> np.allclose([1e10,1e-8], [1.0001e10,1e-9])  # doctest: +SKIP
False

This example is valid syntax, but we were not able to check execution

>>> np.allclose([1.0, np.nan], [1.0, np.nan])  # doctest: +SKIP
False

This example is valid syntax, but we were not able to check execution

>>> np.allclose([1.0, np.nan], [1.0, np.nan], equal_nan=True)  # doctest: +SKIP
True

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

dask.array.routines.allclose dask.array.routines.isclose

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/routines.py#1965
type: <class 'function'>
Commit: