pyarrow.compute.cumulative_sum

pyarrow.compute.cumulative_sum(values, /, start=0.0, *, 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. Results will wrap around on integer overflow. Use function “cumulative_sum_checked” if you want overflow to return an error.

Parameters:

valuesArray-like

Argument to compute function.

startScalar, default 0.0

Starting value for sum computation

skip_nullsbool, default False

When false, the first encountered null is propagated.

optionspyarrow.compute.CumulativeSumOptions, optional

Alternative way of passing options.

memory_poolpyarrow.MemoryPool, optional

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

previous

pyarrow.compute.variance

next

pyarrow.compute.cumulative_sum_checked