numpy.testing.assert_array_equal#

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

如果两个类数组对象不相等，则引发 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 转换为数组。

参数：

actual类数组: 要检查的实际对象。
desired类数组: 所需的目标对象。
err_msgstr，可选: 失败时要打印的错误消息。
verbosebool，可选: 如果为 True，则冲突的值将附加到错误消息中。
strictbool，可选: 如果为 True，则当类数组对象的形状或数据类型不匹配时，引发 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)