numpy.isclose

numpy.isclose(a, b, rtol=1e-05, atol=1e-08, equal_nan=False)

返回一个布尔数组,其中两个数组在容差范围内逐元素相等.

容差值是正数,通常是非常小的数字.相对差异（rtol * abs(b)）和绝对差异 atol 加在一起,与 a 和 b 之间的绝对差异进行比较.

警告

默认的 atol 不适用于比较数量级远小于1的数字（见注释）.

参数:

a, barray_like

要比较的输入数组.

rtolarray_like

相对容差参数（见注释）.

atolarray_like

绝对容差参数（见注释）.

equal_nanbool

是否将 NaN 视为相等.如果为 True,数组 a 中的 NaN 将被视为与数组 b 中的 NaN 相等.

返回:

yarray_like

返回一个布尔数组,其中 a 和 b 在给定的容差范围内相等.如果 a 和 b 都是标量,则返回单个布尔值.

参见

allclose

math.isclose

备注

在 1.7.0 版本加入.

对于有限值,isclose 使用以下方程来测试两个浮点值是否等价.:

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

与内置的 math.isclose 不同,上述等式在 a 和 b 中不是对称的 – 它假设 b 是参考值 – 因此 isclose(a, b) 可能与 isclose(b, a) 不同.

当参考值 b 的量级小于1时,`atol` 的默认值不合适.例如,``a = 1e-9`` 和 b = 2e-9 应该不太可能被认为是”接近”的,然而 isclose(1e-9, 2e-9) 在默认设置下是 True.务必为当前的使用场景选择合适的 atol,特别是在定义 a 中的非零值在什么阈值下会被认为是”接近” b 中的非常小或零值时.

isclose 对于非数字数据类型未定义.:class:bool 在此目的上被视为数字数据类型.

示例

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

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

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

>>> np.isclose([1.0, np.nan], [1.0, np.nan])
array([ True, False])

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

>>> np.isclose([1e-8, 1e-7], [0.0, 0.0])
array([ True, False])

>>> np.isclose([1e-100, 1e-7], [0.0, 0.0], atol=0.0)
array([False, False])

>>> np.isclose([1e-10, 1e-10], [1e-20, 0.0])
array([ True,  True])

>>> np.isclose([1e-10, 1e-10], [1e-20, 0.999999e-10], atol=0.0)
array([False,  True])