xorbits.pandas.window.Expanding.aggregate

Expanding.aggregate(func, **kwargs)

Aggregate using one or more operations over the specified axis.

Parameters

• func (function, str, list or dict) –

  Function to use for aggregating the data. If a function, must either work when passed a Series/Dataframe or when passed to Series/Dataframe.apply.

  Accepted combinations are:

  • function

  • string function name

  • list of functions and/or function names, e.g. [np.sum, 'mean']

  • dict of axis labels -> functions, function names or list of such.

• *args – Positional arguments to pass to func.

• **kwargs – Keyword arguments to pass to func.

Returns

The return can be:

• scalar : when Series.agg is called with single function

• Series : when DataFrame.agg is called with a single function

• DataFrame : when DataFrame.agg is called with several functions

Return scalar, Series or DataFrame.

Return type

scalar, Series or DataFrame

See also

pandas.DataFrame.aggregate

Similar DataFrame method.

pandas.Series.aggregate

Similar Series method.

Notes

agg is an alias for aggregate. Use the alias.

Functions that mutate the passed object can produce unexpected behavior or errors and are not supported. See gotchas.udf-mutation for more details.

A passed user-defined-function will be passed a Series for evaluation.

Examples

>>> df = pd.DataFrame({"A": [1, 2, 3], "B": [4, 5, 6], "C": [7, 8, 9]})  
>>> df  
   A  B  C
0  1  4  7
1  2  5  8
2  3  6  9

>>> df.ewm(alpha=0.5).mean()  
          A         B         C
0  1.000000  4.000000  7.000000
1  1.666667  4.666667  7.666667
2  2.428571  5.428571  8.428571

This docstring was copied from pandas.core.window.expanding.Expanding.