jax.numpy.allclose#
- jax.numpy.allclose(a, b, rtol=1e-05, atol=1e-08, equal_nan=False)[source]#
Returns True if two arrays are element-wise equal within a tolerance.
LAX-backend implementation of
numpy.allclose().Original docstring below.
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.
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.- 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:
allclose – Returns True if the two arrays are equal within the given tolerance; False otherwise.
- Return type: