jax.numpy.isclose#
- jax.numpy.isclose(a, b, rtol=1e-05, atol=1e-08, equal_nan=False)[source]#
Returns a boolean array where two arrays are element-wise equal within a
LAX-backend implementation of
numpy.isclose()
.Original docstring below.
tolerance.
The tolerance values are positive, typically very small numbers. The relative difference (rtol * abs(b)) and the absolute difference atol are added together to compare against the absolute difference between a and b.
Warning
The default atol is not appropriate for comparing numbers that are much smaller than one (see Notes).
- Parameters:
a (array_like) – Input arrays to compare.
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.
- Returns:
y – Returns a boolean array of where a and b are equal within the given tolerance. If both a and b are scalars, returns a single boolean value.
- Return type:
array_like