numpy.testing.assert_array_equal#

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

如果两个 array_like 对象不相等，则引发 AssertionError。

给定两个 array_like 对象，检查它们的形状是否相等，并且这些对象的所有元素是否相等（但请参阅 Notes 部分关于标量特殊处理的内容）。在形状不匹配或值冲突时会引发异常。与 NumPy 的标准用法相反，NaNs 被视为数字进行比较，如果两个对象在相同位置都有 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, optional: 失败时要打印的错误消息。
verbosebool, optional: 如果为 True，则将冲突的值附加到错误消息中。
strictbool, optional: 如果为 True，则当 array_like 对象的形状或数据类型不匹配时，引发 AssertionError。Notes 部分提到的标量特殊处理将被禁用。

版本 1.24.0 新增。

引发:

AssertionError: 当 actual 和 desired 对象不相等时。

另请参阅

assert_allclose: 以期望的相对和/或绝对精度比较两个 array_like 对象是否相等。
assert_array_almost_equal_nulp, assert_array_max_ulp, assert_equal

备注

当 actual 和 desired 中有一个是标量，另一个是 array_like 时，函数检查 array_like 的每个元素是否等于标量。请注意，因此空数组被视为等于标量。通过将 strict==True 可以禁用此行为。

示例

第一次断言不引发异常

>>> 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%)
Mismatch at index:
 [1]: 3.141592653589793 (ACTUAL), 3.1415926535897927 (DESIRED)
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)

如 Notes 部分所述，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)