pyarrow.compute.cumulative_max

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

Compute the cumulative max over a numeric input.

values must be numeric. Return an array/chunked array which is the cumulative max computed over values. The default start is the minimum value of input type (so that any other value will replace the start as the new maximum).

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.