pandas.core.window.expanding.Expanding.sum#

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.

New in version 1.5.0.

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 setting compute.use_numba

    New in version 1.3.0.

engine_kwargsdict, default None
  • For 'cython' engine, there are no accepted engine_kwargs

  • For 'numba' engine, the engine can accept nopython, nogil and parallel dictionary keys. The values must either be True or False. The default engine_kwargs for the 'numba' engine is {'nopython': True, 'nogil': False, 'parallel': False}

    New in version 1.3.0.

Returns:
Series or DataFrame

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

See also

pandas.Series.expanding

Calling expanding with Series data.

pandas.DataFrame.expanding

Calling expanding with DataFrames.

pandas.Series.sum

Aggregating sum for Series.

pandas.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