nlcpy.bitwise_or

nlcpy.bitwise_or = <ufunc 'nlcpy_bitwise_or'>

Computes the bit-wise OR of two arrays element-wise.

This ufunc implements the C/Python operator |.

Parameters

x1, x2array_like: Only integer and boolean types are handled. 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: y = x1 | x2. If x1 and x2 are both scalars, this function returns the result as a 0-dimension ndarray.

See also

logical_or: Computes the logical OR of two arrays element-wise.
bitwise_and: Computes the bit-wise AND of two arrays element-wise.
bitwise_xor: Computes the bit-wise XOR of two arrays element-wise.

Examples

The number 13 has the binaray representation 00001101. Likewise, 16 is represented by 00010000. The bit-wise OR of 13 and 16 is then 000111011, or 29:

>>> import nlcpy as vp
>>> vp.bitwise_or(13, 16)
array(29)
>>> vp.bitwise_or(32, 2)
array(34)
>>> vp.bitwise_or([33,3], 1)
array([33,  3])
>>> vp.bitwise_or([33, 4], [1, 2])
array([33,  6])
>>> vp.bitwise_or(vp.array([2, 5, 255]), vp.array([4, 4, 4]))
array([  6,   5, 255])
>>> vp.array([2, 5, 255]) | vp.array([4, 4, 4])
array([  6,   5, 255])
>>> vp.bitwise_or(vp.array([2, 5, 255, 2147483647], dtype=vp.int32),
...               vp.array([4, 4, 4, 2147483647], dtype=vp.int32))
array([         6,          5,        255, 2147483647], dtype=int32)
>>> vp.bitwise_or([True, True], [False, True])
array([ True,  True])