numpy.allclose#

numpy.allclose(a, b, rtol=1e-05, atol=1e-08, equal_nan=False)[源代码]#

如果两个数组在容差范围内逐元素相等，则返回 True。

容差值是正数，通常是非常小的数字。相对差值 (rtol * abs(b)) 和绝对差值 atol 相加后与 a 和 b 之间的绝对差值进行比较。

警告

默认的 atol 不适合比较远小于一的数字（参见注意事项）。

如果 NaNs 位于相同位置且 equal_nan=True，则它们被视为相等。如果 Infs 位于相同位置且在两个数组中具有相同符号，则它们被视为相等。

参数:

a, b类数组: 要比较的输入数组。
rtol类数组: 相对容差参数（参见注意事项）。
atol类数组: 绝对容差参数（参见注意事项）。
equal_nan布尔型: 是否将 NaN 视为相等。如果为 True，则输出数组中 a 中的 NaN 将被视为与 b 中的 NaN 相等。

返回:

allclose布尔型: 如果两个数组在给定容差范围内相等，则返回 True；否则返回 False。

另请参阅

isclose, all, any, equal

注意事项

如果以下等式逐元素为 True，则 allclose 返回 True。

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

上述等式在 a 和 b 中不对称，因此在某些罕见情况下，allclose(a, b) 可能与 allclose(b, a) 不同。

当参考值 b 的量级小于一时，atol 的默认值不合适。例如，a = 1e-9 和 b = 2e-9 不太可能被视为“接近”，然而在默认设置下 allclose(1e-9, 2e-9) 为 True。请务必根据具体用例选择 atol，特别是要定义一个阈值，低于该阈值时，a 中的非零值将被视为“接近” b 中的一个非常小或零的值。

对 a 和 b 的比较使用标准广播，这意味着 a 和 b 不需要具有相同的形状，即可使 allclose(a, b) 评估为 True。equal 也是如此，但 array_equal 则不然。

allclose 未为非数值数据类型定义。bool 在此目的下被视为数值数据类型。

示例

>>> import numpy as np
>>> np.allclose([1e10,1e-7], [1.00001e10,1e-8])
False

>>> np.allclose([1e10,1e-8], [1.00001e10,1e-9])
True

>>> np.allclose([1e10,1e-8], [1.0001e10,1e-9])
False

>>> np.allclose([1.0, np.nan], [1.0, np.nan])
False

>>> np.allclose([1.0, np.nan], [1.0, np.nan], equal_nan=True)
True