This is documentation for an old release of NumPy (version 1.19). Read this page Search for this page in the documentation of the latest stable release (version 2.2).

numpy.array_equiv

numpy.array_equiv(a1, a2)

Returns True if input arrays are shape consistent and all elements equal.

Shape consistent means they are either the same shape, or one input array can be broadcasted to create the same shape as the other one.

Parameters

a1, a2array_like

Input arrays.

Returns

outbool

True if equivalent, False otherwise.

Examples

>>>

>>> np.array_equiv([1, 2], [1, 2])
True
>>> np.array_equiv([1, 2], [1, 3])
False

Showing the shape equivalence:

>>>

>>> np.array_equiv([1, 2], [[1, 2], [1, 2]])
True
>>> np.array_equiv([1, 2], [[1, 2, 1, 2], [1, 2, 1, 2]])
False

>>>

>>> np.array_equiv([1, 2], [[1, 2], [1, 3]])
False