numpy.testing.assert_allclose#

testing.assert_allclose(actual, desired, rtol=1e-07, atol=0, equal_nan=True, err_msg='', verbose=True, *, strict=False)[源代码]#

如果两个对象在所需的容差范围内不相等,则引发 AssertionError.

给定两个类数组对象,检查它们的形状和所有元素是否相等(但请参阅 Notes 中对标量的特殊处理). 如果形状不匹配或任何值冲突,则会引发异常. 与 numpy 中的标准用法相反,NaN 像数字一样进行比较,如果两个对象在相同的位置都有 NaN,则不会引发断言.

该测试等价于 allclose(actual, desired, rtol, atol) (注意 allclose 具有不同的默认值).它将 actual 和 desired 之间的差异与 atol + rtol * abs(desired) 进行比较.

参数:
actualarray_like

获得的数组.

desiredarray_like

期望的数组.

rtolfloat,可选

相对容差.

atolfloat,可选

绝对容差.

equal_nanbool,可选.

如果为 True,则 NaN 将被视为相等.

err_msgstr, optional

在失败的情况下要打印的错误消息.

verbosebool, 可选

如果为 True,则冲突的值将附加到错误消息中.

strictbool, 可选

如果为 True,则当参数的形状或数据类型不匹配时,引发 AssertionError .注释部分中提到的对标量的特殊处理将被禁用.

在 2.0.0 版本加入.

提出:
AssertionError

如果 actual 和 desired 在指定的精度内不相等.

参见

assert_array_almost_equal_nulp , assert_array_max_ulp

注释

当 actual 和 desired 之一是标量,而另一个是类数组时,该函数执行比较,就好像标量被广播到数组的形状一样.可以使用 strict 参数禁用此行为.

示例

>>> x = [1e-5, 1e-3, 1e-1]
>>> y = np.arccos(np.cos(x))
>>> np.testing.assert_allclose(x, y, rtol=1e-5, atol=0)

如注释部分所述, assert_allclose 对标量有特殊的处理.在这里,测试检查 numpy.sin 的值在 π 的整数倍数处是否接近零.

>>> x = np.arange(3) * np.pi
>>> np.testing.assert_allclose(np.sin(x), 0, atol=1e-15)

当将具有一个或多个维度的数组与标量进行比较时,使用 strict 来引发 AssertionError .

>>> np.testing.assert_allclose(np.sin(x), 0, atol=1e-15, strict=True)
Traceback (most recent call last):
    ...
AssertionError:
Not equal to tolerance rtol=1e-07, atol=1e-15

(shapes (3,), () mismatch)
 ACTUAL: array([ 0.000000e+00,  1.224647e-16, -2.449294e-16])
 DESIRED: array(0)

strict 参数还确保数组数据类型匹配:

>>> y = np.zeros(3, dtype=np.float32)
>>> np.testing.assert_allclose(np.sin(x), y, atol=1e-15, strict=True)
Traceback (most recent call last):
    ...
AssertionError:
Not equal to tolerance rtol=1e-07, atol=1e-15

(dtypes float64, float32 mismatch)
 ACTUAL: array([ 0.000000e+00,  1.224647e-16, -2.449294e-16])
 DESIRED: array([0., 0., 0.], dtype=float32)