Function assert_array_equal

cupy/testing/_array.py:102–147

Raises an AssertionError if two array_like objects are not equal. Args: x(numpy.ndarray or cupy.ndarray): The actual object to check. y(numpy.ndarray or cupy.ndarray): The desired, expected object. strides_check(bool): If ``True``, consistency of strides is also

(
        actual, desired, err_msg='', verbose=True, *,
        strict=False, strides_check=False
)

def assert_array_equal(
        actual, desired, err_msg='', verbose=True, *,
        strict=False, strides_check=False
):
    """Raises an AssertionError if two array_like objects are not equal.

    Args:
         x(numpy.ndarray or cupy.ndarray): The actual object to check.
         y(numpy.ndarray or cupy.ndarray): The desired, expected object.
         strides_check(bool): If ``True``, consistency of strides is also
             checked.
         err_msg(str): The error message to be printed in case of failure.
         verbose(bool): If ``True``, the conflicting values
             are appended to the error message.
         strict(bool): If ``True``, raise an AssertionError when either
             the shape or the data type of the array_like objects does not
             match. Requires NumPy version 1.24 or above.

    .. seealso:: :func:`numpy.testing.assert_array_equal`
    """
    if numpy.lib.NumpyVersion(numpy.__version__) >= '1.24.0':
        numpy.testing.assert_array_equal(
            cupy.asnumpy(actual), cupy.asnumpy(desired), err_msg=err_msg,
            verbose=verbose, strict=strict,
        )
    else:
        if strict:
            warnings.warn(
                '`cupy.testing.assert_allclose` does not support `strict` '
                'option with NumPy v1.',
                RuntimeWarning
            )
        numpy.testing.assert_array_equal(
            cupy.asnumpy(actual), cupy.asnumpy(desired), err_msg=err_msg,
            verbose=verbose,
        )

    if strides_check:
        if actual.strides != desired.strides:
            msg = ['Strides are not equal:']
            if err_msg:
                msg = [msg[0] + ' ' + err_msg]
            if verbose:
                msg.append(' x: {}'.format(actual.strides))
                msg.append(' y: {}'.format(desired.strides))
            raise AssertionError('\n'.join(msg))


def assert_array_list_equal(xlist, ylist, err_msg='', verbose=True):