pyarrow.compute.sum — Apache Arrow v20.0.0 (original) (raw)

pyarrow.compute.sum(array, /, *, skip_nulls=True, min_count=1, options=None, memory_pool=None)#

Compute the sum of a numeric array.

Null values are ignored by default. Minimum count of non-null values can be set and null is returned if too few are present. This can be changed through ScalarAggregateOptions.

Parameters:

arrayArray-like

Argument to compute function.

skip_nullsbool, default True

Whether to skip (ignore) nulls in the input. If False, any null in the input forces the output to null.

min_countint, default 1

Minimum number of non-null values in the input. If the number of non-null values is below min_count, the output is null.

optionspyarrow.compute.ScalarAggregateOptions, optional

Alternative way of passing options.

memory_poolpyarrow.MemoryPool, optional

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