Skip to content

pandasx / Expanding

Class: Expanding<T> ​

Defined in: src/window.ts:285

Expanding window: everything up to the current row (series.expanding()).

Extends ​

  • Window<T>

Type Parameters ​

Type ParameterDefault type
T extends WindowTargetWindowTarget

Constructors ​

Constructor ​

new Expanding<T>(target, options?): Expanding<T>

Defined in: src/window.ts:288

Parameters ​

ParameterType
targetT
options{ minPeriods?: number; }
options.minPeriods?number

Returns ​

Expanding<T>

Overrides ​

Window<T>.constructor

Methods ​

agg() ​

agg(func): WindowTarget

Defined in: src/window.ts:125

One aggregation name or a list (DataFrame of results for a Series).

Parameters ​

ParameterType
funcstring | readonly string[]

Returns ​

WindowTarget

Inherited from ​

Window.agg


apply() ​

Call Signature ​

apply(fn, options?): T

Defined in: src/window.ts:117

Applies fn to each window: a Series by default, like pandas (raw=False), or a Float64Array of the values with { raw: true } (faster).

Parameters ​
ParameterType
fn(window) => number
options?{ raw?: false; }
options.raw?false
Returns ​

T

Inherited from ​

Window.apply

Call Signature ​

apply(fn, options): T

Defined in: src/window.ts:118

Applies fn to each window: a Series by default, like pandas (raw=False), or a Float64Array of the values with { raw: true } (faster).

Parameters ​
ParameterType
fn(values) => number
options{ raw: true; }
options.rawtrue
Returns ​

T

Inherited from ​

Window.apply


corr() ​

corr(other, options?): T

Defined in: src/window.ts:142

Rolling Pearson correlation with other (Series: pairwise per column).

Parameters ​

ParameterType
otherSeries
options{ ddof?: number; }
options.ddof?number

Returns ​

T

Inherited from ​

Window.corr


count() ​

count(): T

Defined in: src/window.ts:87

Returns ​

T

Inherited from ​

Window.count


cov() ​

cov(other, options?): T

Defined in: src/window.ts:149

Parameters ​

ParameterType
otherSeries
options{ ddof?: number; }
options.ddof?number

Returns ​

T

Inherited from ​

Window.cov


kurt() ​

kurt(): T

Defined in: src/window.ts:94

Returns ​

T

Inherited from ​

Window.kurt


max() ​

max(): T

Defined in: src/window.ts:96

Returns ​

T

Inherited from ​

Window.max


mean() ​

mean(): T

Defined in: src/window.ts:89

Returns ​

T

Inherited from ​

Window.mean


median() ​

median(): T

Defined in: src/window.ts:97

Returns ​

T

Inherited from ​

Window.median


min() ​

min(): T

Defined in: src/window.ts:95

Returns ​

T

Inherited from ​

Window.min


quantile() ​

quantile(q, interpolation?): T

Defined in: src/window.ts:98

Parameters ​

ParameterTypeDefault value
qnumberundefined
interpolation"linear" | "lower" | "higher" | "midpoint" | "nearest"'linear'

Returns ​

T

Inherited from ​

Window.quantile


rank() ​

rank(options?): T

Defined in: src/window.ts:102

Rank of the last value within its window (average ties), optionally as a fraction.

Parameters ​

ParameterType
options{ ascending?: boolean; pct?: boolean; }
options.ascending?boolean
options.pct?boolean

Returns ​

T

Inherited from ​

Window.rank


sem() ​

sem(ddof?): T

Defined in: src/window.ts:92

Parameters ​

ParameterTypeDefault value
ddofnumber1

Returns ​

T

Inherited from ​

Window.sem


skew() ​

skew(): T

Defined in: src/window.ts:93

Returns ​

T

Inherited from ​

Window.skew


std() ​

std(ddof?): T

Defined in: src/window.ts:91

Parameters ​

ParameterTypeDefault value
ddofnumber1

Returns ​

T

Inherited from ​

Window.std


sum() ​

sum(): T

Defined in: src/window.ts:88

Returns ​

T

Inherited from ​

Window.sum


var() ​

var(ddof?): T

Defined in: src/window.ts:90

Parameters ​

ParameterTypeDefault value
ddofnumber1

Returns ​

T

Inherited from ​

Window.var

Released under the MIT License.