dpnp.equal

dpnp.equal(x1, x2, /, out=None, *, order='K', where=True, dtype=None, subok=True, **kwargs)

Return the truth value of (x1 == x2) element-wise.

For full documentation refer to numpy.equal.

Returns:

out – Output array of bool type, element-wise comparison of x1 and x2.

Return type:

dpnp.ndarray

Limitations

Parameters x1 and x2 are supported as either scalar, dpnp.ndarray or dpctl.tensor.usm_ndarray, but both x1 and x2 can not be scalars at the same time. Parameters where, dtype and subok are supported with their default values. Otherwise the function will be executed sequentially on CPU. Input array data types are limited by supported DPNP Data types.

See also

dpnp.not_equal

Return (x1 != x2) element-wise.

dpnp.greater_equal

Return the truth value of (x1 >= x2) element-wise.

dpnp.less_equal

Return the truth value of (x1 =< x2) element-wise.

dpnp.greater

Return the truth value of (x1 > x2) element-wise.

dpnp.less

Return the truth value of (x1 < x2) element-wise.

Examples

>>> import dpnp as np
>>> x1 = np.array([0, 1, 3])
>>> x2 = np.arange(3)
>>> np.equal(x1, x2)
array([ True,  True, False])

What is compared are values, not types. So an int (1) and an array of length one can evaluate as True:

>>> np.equal(1, np.ones(1))
array([ True])

The == operator can be used as a shorthand for equal on dpnp.ndarray.

>>> a = np.array([2, 4, 6])
>>> b = np.array([2, 4, 2])
>>> a == b
array([ True,  True, False])