Skip to main content
`Ctrl`+`K`

# pandas.api.typing.ExponentialMovingWindow.sum

ExponentialMovingWindow.sum(numeric_only=False, engine=None, engine_kwargs=None)

  Calculate the ewm (exponential weighted moment) sum.

  The weighting is controlled by the `com`, `span`, `halflife`, or `alpha` parameter specified when calling `DataFrame.ewm()` or `Series.ewm()`.

  Parameters:
    numeric_only bool, default False

      Include only float, int, boolean columns.

    engine str, 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`

    engine_kwargs dict, default None

      - For `'cython'` engine, there are no accepted `engine_kwargs`

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

  Returns:
    Series or DataFrame

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

  See also

  `Series.ewm`

    Calling ewm with Series data.

  `DataFrame.ewm`

    Calling ewm 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])
      >>> ser.ewm(alpha=0.2).sum()
      0    1.000
      1    2.800
      2    5.240
      3    8.192
      dtype: float64