pyarrow.compute.shift_left_checked#

pyarrow.compute.shift_left_checked(x, y, /, *, memory_pool=None)#

Left shift x by y.

The shift operates as if on the twos complement representation of the number. In other words, this is equivalent to multiplying x by 2 to the power y, even if overflow occurs. An error is raised if y (the amount to shift by) is (1) negative or (2) greater than or equal to the precision of x. See shift_left for a variant that doesnt fail for an invalid shift amount.

Parameters:

xArray-like or scalar-like

Argument to compute function.

yArray-like or scalar-like

Argument to compute function.

memory_poolpyarrow.MemoryPool, optional

If not passed, will allocate memory from the default memory pool.