numpy.testing.assert_array_equal#

testing.assert_array_equal(actual, desired, err_msg='', verbose=True, *, strict=False)[源代码]#

如果两个 array_like 对象不相等,则引发 AssertionError.

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

通常建议在验证浮点数相等性时保持谨慎.

备注

当 actual 或 desired 已经是 numpy.ndarray 的实例且 desired 不是 dict 时,``assert_equal(actual, desired)`` 的行为与该函数的行为相同.否则,该函数在比较之前对输入执行 np.asanyarray,而 assert_equal 为常见的 Python 类型定义了特殊的比较规则.例如,只有 assert_equal 可以用于比较嵌套的 Python 列表.在新代码中,考虑仅使用 assert_equal,如果需要 assert_array_equal 的行为,则显式地将 actual 或 desired 转换为数组.

参数:
actualarray_like

要检查的实际对象.

desiredarray_like

期望的对象.

err_msgstr, 可选

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

verbosebool, 可选

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

strictbool, 可选

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

在 1.24.0 版本加入.

引发:
AssertionError

如果实际对象和期望对象不相等.

参见

assert_allclose

比较两个类似数组的对象是否相等,具有期望的相对和/或绝对精度.

assert_array_almost_equal_nulp, assert_array_max_ulp, assert_equal

备注

当 actual 和 desired 之一是标量而另一个是类数组时,该函数会检查类数组对象的每个元素是否等于该标量.可以通过 strict 参数禁用此行为.

示例

第一个断言不会引发异常:

>>> np.testing.assert_array_equal([1.0,2.33333,np.nan],
...                               [np.exp(0),2.33333, np.nan])

断言因浮点数的数值精度问题而失败:

>>> np.testing.assert_array_equal([1.0,np.pi,np.nan],
...                               [1, np.sqrt(np.pi)**2, np.nan])
Traceback (most recent call last):
    ...
AssertionError:
Arrays are not equal

Mismatched elements: 1 / 3 (33.3%)
Max absolute difference among violations: 4.4408921e-16
Max relative difference among violations: 1.41357986e-16
 ACTUAL: array([1.      , 3.141593,      nan])
 DESIRED: array([1.      , 3.141593,      nan])

在这些情况下,请使用 assert_allclose 或其中一个 nulp（浮点值的数量）函数:

>>> np.testing.assert_allclose([1.0,np.pi,np.nan],
...                            [1, np.sqrt(np.pi)**2, np.nan],
...                            rtol=1e-10, atol=0)

如备注部分所述,`assert_array_equal` 对标量有特殊处理.这里测试检查 x 中的每个值是否为 3:

>>> x = np.full((2, 5), fill_value=3)
>>> np.testing.assert_array_equal(x, 3)

使用 strict 在比较标量和数组时引发 AssertionError:

>>> np.testing.assert_array_equal(x, 3, strict=True)
Traceback (most recent call last):
    ...
AssertionError:
Arrays are not equal

(shapes (2, 5), () mismatch)
 ACTUAL: array([[3, 3, 3, 3, 3],
       [3, 3, 3, 3, 3]])
 DESIRED: array(3)

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

>>> x = np.array([2, 2, 2])
>>> y = np.array([2., 2., 2.], dtype=np.float32)
>>> np.testing.assert_array_equal(x, y, strict=True)
Traceback (most recent call last):
    ...
AssertionError:
Arrays are not equal

(dtypes int64, float32 mismatch)
 ACTUAL: array([2, 2, 2])
 DESIRED: array([2., 2., 2.], dtype=float32)
On this page