numpy.testing.assert_allclose#

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

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

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

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

在 1.5.0 版本加入.

参数:
actualarray_like

数组已获取.

desiredarray_like

数组期望.

rtolfloat, 可选

相对容差.

atolfloat, 可选

绝对容差.

equal_nanbool, 可选.

如果为真,NaN 将比较相等.

err_msgstr, 可选

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

verbosebool, 可选

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

strictbool, 可选

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

在 2.0.0 版本加入.

引发:
AssertionError

如果实际值和期望值在指定精度下不相等.

参见

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)
On this page