pyarrow.compute.cumulative_sum_checked

pyarrow.compute.cumulative_sum_checked(values, /, start=None, *, skip_nulls=False, options=None, memory_pool=None)

Compute the cumulative sum over a numeric input.

values must be numeric. Return an array/chunked array which is the cumulative sum computed over values. This function returns an error on overflow. For a variant that doesn’t fail on overflow, use function “cumulative_sum”. The default start is 0.

Parameters:

valuesArray-like

Argument to compute function.

startScalar, default None

Starting value for the cumulative operation. If none is given, a default value depending on the operation and input type is used.

skip_nullsbool, default False

When false, the first encountered null is propagated.

optionspyarrow.compute.CumulativeOptions, optional

Alternative way of passing options.

memory_poolpyarrow.MemoryPool, optional

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