nums.numpy.right_shift

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

Shift the bits of an integer to the right.

This docstring was copied from numpy.right_shift.

Some inconsistencies with the NumS version may exist.

Bits are shifted to the right x2. Because the internal representation of numbers is in binary format, this operation is equivalent to dividing x1 by 2**x2.

Parameters

x1 (BlockArray, int) – Input values.
x2 (BlockArray, int) – Number of bits to remove at the right of x1. 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 – Return x1 with bits shifted x2 times to the right.

Return type

BlockArray