bundles / numpy 2.4.3 / numpy / equal
ufunc
numpy:equal
source: /numpy/__init__.py
Summary
Return (x1 == x2) element-wise.
Parameters
x1, x2: array_likeInput arrays. If
x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).out: ndarray, None, or tuple of ndarray and None, optionalA location into which the result is stored. If provided, it must have a shape that the inputs broadcast to. If not provided or None, a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs.
where: array_like, optionalThis condition is broadcast over the input. At locations where the condition is True, the out array will be set to the ufunc result. Elsewhere, the out array will retain its original value. Note that if an uninitialized out array is created via the default
out=None, locations within it where the condition is False will remain uninitialized.**kwargsFor other keyword-only arguments, see the
ufunc docs <ufuncs.kwargs>.
Returns
out: ndarray or scalarOutput array, element-wise comparison of x1 and x2. Typically of type bool, unless
dtype=objectis passed. This is a scalar if both x1 and x2 are scalars.
Examples
import numpy as np np.equal([0, 1, 3], np.arange(3))✓
np.equal(1, np.ones(1))
✓a = np.array([2, 4, 6]) b = np.array([2, 4, 2]) a == b✓
See also
- greater
- greater_equal
- less
- less_equal
- not_equal
Aliases
-
numpy.equal