pyarrow.compute.cumulative_sum_checked¶
- pyarrow.compute.cumulative_sum_checked(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. This function returns an error on overflow. For a variant that doesn’t fail on overflow, use function “cumulative_sum”.
- Parameters:
- valuesArray-like
Argument to compute function.
- start
Scalar
, default 0.0 Starting value for sum computation
- skip_nullsbool, default
False
When false, the first encountered null is propagated.
- options
pyarrow.compute.CumulativeSumOptions
, optional Alternative way of passing options.
- memory_pool
pyarrow.MemoryPool
, optional If not passed, will allocate memory from the default memory pool.