pyarrow.compute.CumulativeOptions

class pyarrow.compute.CumulativeOptions(start=None, *, skip_nulls=False)

Bases: _CumulativeOptions

Options for cumulative_* functions.

• cumulative_sum

• cumulative_sum_checked

• cumulative_prod

• cumulative_prod_checked

• cumulative_max

• cumulative_min

Parameters:

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.

__init__(self, start=None, *, skip_nulls=False)

Methods

__init__(self[, start, skip_nulls])
deserialize(buf)	Deserialize options for a function.
serialize(self)

static deserialize(buf)

Deserialize options for a function.

Parameters:

bufBuffer

The buffer containing the data to deserialize.

serialize(self)