turicreate.SArray.rolling_var

SArray.rolling_var(window_start, window_end, min_observations=None)

Calculate a new SArray of the variance of different subsets over this SArray.

The subset that the variance is calculated over is defined as an inclusive range relative to the position to each value in the SArray, using window_start and window_end. For a better understanding of this, see the examples below.

Parameters:

window_start : int

The start of the subset to calculate the variance relative to the current value.

window_end : int

The end of the subset to calculate the variance relative to the current value. Must be greater than window_start.

min_observations : int

Minimum number of non-missing observations in window required to calculate the variance (otherwise result is None). None signifies that the entire window must not include a missing value. A negative number throws an error.

Returns:

out : SArray

Examples

>>> import pandas
>>> sa = SArray([1,2,3,4,5])
>>> series = pandas.Series([1,2,3,4,5])

A rolling variance with a window including the previous 2 entries including the current: >>> sa.rolling_var(-2,0) dtype: float Rows: 5 [None, None, 0.6666666666666666, 0.6666666666666666, 0.6666666666666666]

Pandas equivalent: >>> pandas.rolling_var(series, 3, ddof=0) 0 NaN 1 NaN 2 0.666667 3 0.666667 4 0.666667 dtype: float64

Same rolling variance operation, but 2 minimum observations: >>> sa.rolling_var(-2,0,min_observations=2) dtype: float Rows: 5 [None, 0.25, 0.6666666666666666, 0.6666666666666666, 0.6666666666666666]

Pandas equivalent: >>> pandas.rolling_var(series, 3, ddof=0, min_periods=2) 0 NaN 1 0.250000 2 0.666667 3 0.666667 4 0.666667 dtype: float64

A rolling variance with a size of 3, centered around the current: >>> sa.rolling_var(-1,1) dtype: float Rows: 5 [None, 0.6666666666666666, 0.6666666666666666, 0.6666666666666666, None]

Pandas equivalent: >>> pandas.rolling_var(series, 3, center=True) 0 NaN 1 0.666667 2 0.666667 3 0.666667 4 NaN dtype: float64

A rolling variance with a window including the current and the 2 entries following: >>> sa.rolling_var(0,2) dtype: float Rows: 5 [0.6666666666666666, 0.6666666666666666, 0.6666666666666666, None, None]

A rolling variance with a window including the previous 2 entries NOT including the current: >>> sa.rolling_var(-2,-1) dtype: float Rows: 5 [None, None, 0.25, 0.25, 0.25]