nlcpy.equal

nlcpy.equal = <ufunc 'nlcpy_equal'>

Returns (x1 == x2), element-wise.

Parameters

x1, x2array_like

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

outndarray or None, 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.

wherearray_like, 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 section Optional Keyword Arguments.

Returns

yndarray

A ndarray, containing the result of the element-wise comparison of x1 and x2; the shape is determined by broadcasting. If x1 and x2 are both scalars, this function returns the result as a 0-dimension ndarray.

See also

not_equal

Returns (x1 != x2), element-wise.

greater_equal

Returns (x1 >= x2), element-wise.

less_equal

Returns (x1 <= x2), element-wise.

greater

Returns (x1 > x2), element-wise.

less

Returns (x1 < x2), element-wise.

Examples

>>> import nlcpy as vp
>>> vp.equal([0, 1, 3], vp.arange(3))
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:

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