pyarrow.compute.shift_left¶
-
pyarrow.compute.
shift_left
(x, y, *, memory_pool=None)¶ Left shift x by y.
This function will return x if y (the amount to shift by) is: (1) negative or (2) greater than or equal to the precision of x. The shift operates as if on the two’s complement representation of the number. In other words, this is equivalent to multiplying x by 2 to the power y, even if overflow occurs. Use function “shift_left_checked” if you want an invalid shift amount to return an error.
- Parameters
x (Array-like or scalar-like) – Argument to compute function
y (Array-like or scalar-like) – Argument to compute function
memory_pool (pyarrow.MemoryPool, optional) – If not passed, will allocate memory from the default memory pool.