numpy.isclose#
- numpy.isclose(a, b, rtol=1e-05, atol=1e-08, equal_nan=False)[源代码]#
返回一个布尔数组,其中两个数组在容差范围内逐元素相等。
容差值是正的,通常是非常小的数字。相对差值(rtol * abs(b))和绝对差值 atol 相加,与 a 和 b 之间的绝对差值进行比较。
警告
默认的 atol 不适用于比较绝对值远小于一的数字(参见 Notes)。
- 参数:
- a, barray_like
要比较的输入数组。
- rtolarray_like
相对容差参数(参见 Notes)。
- atolarray_like
绝对容差参数(参见 Notes)。
- equal_nanbool
是否将 NaN 视为相等。如果为 True,则输出数组中 a 中的 NaN 将被视为与 b 中的 NaN 相等。
- 返回:
- yarray_like
返回一个布尔数组,指示 a 和 b 在给定容差内是否相等。如果 a 和 b 都是标量,则返回单个布尔值。
另请参阅
备注
对于有限值,isclose 使用以下方程来测试两个浮点值是否等价。
absolute(a - b) <= (atol + rtol * absolute(b))
与内置的
math.isclose不同,上述方程在 a 和 b 之间不是对称的——它假定 b 是参考值——因此 isclose(a, b) 可能与 isclose(b, a) 不同。当参考值 b 的绝对值小于一时,默认的 atol 值不适用。例如,不太可能认为
a = 1e-9和b = 2e-9是“接近”的,但是使用默认设置时isclose(1e-9, 2e-9)为True。务必根据具体用例选择 atol,特别是用于定义一个阈值,低于该阈值时 a 中的非零值将被视为“接近” b 中一个非常小或为零的值。isclose对于非数值数据类型未定义。为此目的,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])