nums.numpy.equal

nums.numpy.equal(x1, x2, out=None, where=True, **kwargs)

Return (x1 == x2) element-wise.

This docstring was copied from numpy.equal.

Some inconsistencies with the NumS version may exist.

Parameters

• x1 (BlockArray) – Input arrays. If x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).

• x2 (BlockArray) – Input arrays. If x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).

• out (BlockArray, None, or optional) – A 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 (BlockArray, optional) – This 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.

• **kwargs – For other keyword-only arguments, see the ufunc docs.

Returns

out – Output array, element-wise comparison of x1 and x2. Typically of type bool, unless dtype=object is passed.

Return type

BlockArray

See also

not_equal, greater_equal, less_equal, greater, less

Examples

The doctests shown below are copied from NumPy. They won’t show the correct result until you operate get().

>>> nps.equal(nps.array([0, 1, 3]), nps.arange(3)).get()  
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:

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