pyarrow.compute.cumulative_prod#
- pyarrow.compute.cumulative_prod(values, /, start=None, *, skip_nulls=False, options=None, memory_pool=None)#
Compute the cumulative product over a numeric input.
values must be numeric. Return an array/chunked array which is the cumulative product computed over values. Results will wrap around on integer overflow. Use function “cumulative_prod_checked” if you want overflow to return an error. The default start is 1.
- Parameters:
- valuesArray-like
Argument to compute function.
- start
Scalar
, defaultNone
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.
- options
pyarrow.compute.CumulativeOptions
, optional Alternative way of passing options.
- memory_pool
pyarrow.MemoryPool
, optional If not passed, will allocate memory from the default memory pool.