nums.numpy.bitwise_or

nums.numpy.bitwise_or(x1, x2, out=None, where=True, **kwargs)[source]

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

This docstring was copied from numpy.bitwise_or.

Some inconsistencies with the NumS version may exist.

Computes the bit-wise OR of the underlying binary representation of the integers in the input arrays. This ufunc implements the C/Python operator |.

Parameters

  • x1 (BlockArray) – 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).

  • x2 (BlockArray) – 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).

  • 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 – Result.

Return type

BlockArray

See also

logical_or, bitwise_and, bitwise_xor

binary_repr

Return the binary representation of the input number as a string.

Examples

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

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:

>>> nps.bitwise_or(nps.array(13), nps.array(16)).get()  
array(29)
>>> nps.bitwise_or(nps.array([2, 5, 255]), nps.array([4, 4, 4])).get()  
array([  6,   5, 255])
>>> (nps.array([2, 5, 255]) | nps.array([4, 4, 4])).get()  
array([  6,   5, 255])
>>> nps.bitwise_or(nps.array([True, True]), nps.array([False, True])).get()  
array([ True,  True])