3
���h � @ s� d dl mZ d dlmZmZ d dlmZ d dlm Z m
Z
m Z d dl m
Z
mZmZ d dlmZ G dd� de�ZG d d
� d
e
e�Zd S ) � )�dedent)�Dict�Optional)�function)�Appender� Substitution�doc)�WindowGroupByMixin�
_doc_template� _shared_docs)�_Rolling_and_Expandingc s� e Zd ZdZdddgZdH� fdd � Zed
d � �ZdId d
�Ze d�Z
e d�Z e e
d e
e dddd�� fdd��ZeZedd�ee
d �� fdd���Zedd�ee
d �dJeee eeeef d �� fd d �
��Zedd�ee
d �� fd!d"���Zedd#d$�ee�ee
d# �� fd%d&����Zedd�ee
d' �� fd(d)���Zedd�ee
d* �� fd+d,���Z edd�ee
d- �� fd.d/���Z eddd0�ee
d1 �dK� fd2d3� ��Z eddd0�ee
d4 �dL� fd5d6� ��Z edd7d$�ee�ee
d7 �� fd8d9����Z e d:�Z!ee!�edd�ee
d; �� fd<d=����Z"edd�ee
d> �dM� fd@dA� ��Z#eddBd$�ee�ee
dB �dN� fdCdD� ���Z$edd�ee
dE �dO� fdFdG� ��Z%� Z&S )P� Expandinga�
Provide expanding transformations.
Parameters
----------
min_periods : int, default 1
Minimum number of observations in window required to have a value
(otherwise result is NA).
center : bool, default False
Set the labels at the center of the window.
axis : int or str, default 0
Returns
-------
a Window sub-classed for the particular operation
See Also
--------
rolling : Provides rolling window calculations.
ewm : Provides exponential weighted functions.
Notes
-----
By default, the result is set to the right edge of the window. This can be
changed to the center of the window by setting ``center=True``.
Examples
--------
>>> df = pd.DataFrame({"B": [0, 1, 2, np.nan, 4]})
>>> df
B
0 0.0
1 1.0
2 2.0
3 NaN
4 4.0
>>> df.expanding(2).sum()
B
0 NaN
1 1.0
2 3.0
3 3.0
4 7.0
� min_periods�center�axis� Nr c s t � j||||d� d S )N)�objr r r )�super�__init__)�selfr r r r �kwargs)� __class__� �>/tmp/pip-build-5_djhm0z/pandas/pandas/core/window/expanding.pyr < s zExpanding.__init__c C s t S )N)r
)r r r r � _constructor? s zExpanding._constructorc K s: | j j| j�}t|�|dk t|� }| jp.d}t||�S )au
Get the window length over which to perform some operation.
Parameters
----------
other : object, default None
The other object that is involved in the operation.
Such an object is involved for operations like covariance.
Returns
-------
window : int
The window length.
Nr ���)r Z _get_axisr �lenr �max)r �otherr r �lengthr r r � _get_windowC s
zExpanding._get_windowz�
See Also
--------
pandas.DataFrame.aggregate : Similar DataFrame method.
pandas.Series.aggregate : Similar Series method.
ad
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
� aggregate� zSeries/Dataframe)Zsee_alsoZexamples� versionadded�klassr c s t � j|f|�|�S )N)r r! )r �func�argsr )r r r r! t s zExpanding.aggregateZ expanding)�name�countc s t � jf |�S )N)r r( )r r )r r r r( � s zExpanding.count�applyF)�raw�engine�
engine_kwargsc s t � j||||||d�S )N)r* r+ r, r& r )r r) )r r% r* r+ r, r& r )r r r r) � s zExpanding.apply�sumc s t jd||� t� j||�S )Nr- )�nv�validate_expanding_funcr r- )r r& r )r r r r- � s z
Expanding.sumr )r' � func_namec s t jd||� t� j||�S )Nr )r. r/ r r )r r& r )r r r r � s z
Expanding.max�minc s t jd||� t� j||�S )Nr1 )r. r/ r r1 )r r& r )r r r r1 � s z
Expanding.min�meanc s t jd||� t� j||�S )Nr2 )r. r/ r r2 )r r& r )r r r r2 � s zExpanding.mean�medianc s t � jf |�S )N)r r3 )r r )r r r r3 � s zExpanding.median)r' r# �stdc s$ t jd||� t� jf d|i|��S )Nr4 �ddof)r. r/ r r4 )r r5 r& r )r r r r4 � s z
Expanding.std�varc s$ t jd||� t� jf d|i|��S )Nr6 r5 )r. r/ r r6 )r r5 r& r )r r r r6 � s z
Expanding.var�skewc s t � jf |�S )N)r r7 )r r )r r r r7 � s zExpanding.skewa1
Examples
--------
The example below will show an expanding calculation with a window size of
four matching the equivalent function call using `scipy.stats`.
>>> arr = [1, 2, 3, 4, 999]
>>> import scipy.stats
>>> print(f"{scipy.stats.kurtosis(arr[:-1], bias=False):.6f}")
-1.200000
>>> print(f"{scipy.stats.kurtosis(arr, bias=False):.6f}")
4.999874
>>> s = pd.Series(arr)
>>> s.expanding(4).kurt()
0 NaN
1 NaN
2 NaN
3 -1.200000
4 4.999874
dtype: float64
�kurtc s t � jf |�S )N)r r8 )r r )r r r r8 � s zExpanding.kurt�quantile�linearc s t � jf ||d�|��S )N)r9 �
interpolation)r r9 )r r9 r; r )r r r r9 � s zExpanding.quantile�covc s t � jf |||d�|��S )N)r �pairwiser5 )r r< )r r r= r5 r )r r r r< � s z
Expanding.cov�corrc s t � jf ||d�|��S )N)r r= )r r> )r r r= r )r r r r> � s zExpanding.corr)r Nr )N)FNNNN)r )r )r: )NNr )NN)'�__name__�
__module__� __qualname__�__doc__� _attributesr �propertyr r r Z_agg_see_also_docZ_agg_examples_docr r r! Zaggr r r( �boolr �strr r) r- r
r r1 r2 r3 r4 r6 r7 Z_agg_docr8 r9 r< r> �
__classcell__r r )r r r
sz -
,
r
c @ s e Zd ZdZedd� �ZdS )�ExpandingGroupbyz5
Provide a expanding groupby implementation.
c C s t S )N)r
)r r r r r s z ExpandingGroupby._constructorN)r? r@ rA rB rD r r r r r rH � s rH N)�textwrapr Ztypingr r Zpandas.compat.numpyr r. Zpandas.util._decoratorsr r r Zpandas.core.window.commonr r
r Zpandas.core.window.rollingr r
rH r r r r �<module> s r |