pandas.api.typing.Expanding.sum — pandas 3.0.0rc0+33.g1fd184de2a documentation (original) (raw)

Expanding.sum(numeric_only=False, engine=None, engine_kwargs=None)[source]#

Calculate the expanding sum.

Parameters:

numeric_onlybool, default False

Include only float, int, boolean columns.

enginestr, default None

• 'cython' : Runs the operation through C-extensions from cython.
• 'numba' : Runs the operation through JIT compiled code from numba.
• None : Defaults to 'cython' or globally settingcompute.use_numba

engine_kwargsdict, default None

• For 'cython' engine, there are no accepted engine_kwargs
• For 'numba' engine, the engine can accept nopython, nogiland parallel dictionary keys. The values must either be True orFalse. The default engine_kwargs for the 'numba' engine is{'nopython': True, 'nogil': False, 'parallel': False}

Returns:

Series or DataFrame

Return type is the same as the original object with np.float64 dtype.

See also

Series.expanding

Calling expanding with Series data.

DataFrame.expanding

Calling expanding with DataFrames.

Series.sum

Aggregating sum for Series.

DataFrame.sum

Aggregating sum for DataFrame.

Notes

See Numba engine and Numba (JIT compilation) for extended documentation and performance considerations for the Numba engine.

Examples

ser = pd.Series([1, 2, 3, 4], index=["a", "b", "c", "d"]) ser.expanding().sum() a 1.0 b 3.0 c 6.0 d 10.0 dtype: float64