NumPy Logic functions: equal() function

Last update on August 19 2022 21:50:38 (UTC/GMT +8 hours)

numpy.equal() function

The equal() function is used to return (x1 == x2) element-wise.

Syntax:

numpy.equal(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj]) = <ufunc 'equal'>

Version: 1.15.0

Parameter:

Name	Description	Required / Optional
x1, x2	Input arrays of the same shape. array_like	Required
out	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. ndarray, None, or tuple of ndarray and None	Optional
where	Values of True indicate to calculate the ufunc at that position, values of False indicate to leave the value in the output alone. array_like	Optional
**kwargs	For other keyword-only arguments	Required

Returns:
out : ndarray or scalar - Output array, element-wise comparison of x1 and x2. Typically of type bool, unless dtype=object is passed.
This is a scalar if both x1 and x2 are scalars.

NumPy.equal() method Example:

>>> import numpy as np
>>> np.equal([0, 1, 2, 6], np.arange(4))

Output:

array([ True,  True,  True, False])

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

NumPy.equal() method Example:

>>> import numpy as np
>>> np.equal(1, np.ones(1))

Output:

array([ True])

Python - NumPy Code Editor:

Previous: less_equal() function
Next: not_equal() function