@univerjs/engine-render v0.1.17 • Docs
Class: RollingAverage
RollingAverage
Utility to efficiently compute the rolling average and variance over a sliding window of samples
Constructors
new RollingAverage()
new RollingAverage(length): RollingAverageconstructor
Parameters
| Parameter | Type | Description |
|---|---|---|
length | number | The number of samples required to saturate the sliding window |
Returns
Defined in
submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:173 (opens in a new tab)
Properties
| Property | Modifier | Type | Default value | Description | Defined in |
|---|---|---|---|---|---|
_m2 | protected | number | 0 | - | submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:167 (opens in a new tab) |
_pos | protected | number | 0 | - | submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:165 (opens in a new tab) |
_sampleCount | protected | number | 0 | - | submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:163 (opens in a new tab) |
_samples | protected | number[] | [] | - | submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:161 (opens in a new tab) |
average | public | number | 0 | Current average | submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:154 (opens in a new tab) |
variance | public | number | 0 | Current variance | submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:159 (opens in a new tab) |
Methods
_wrapPosition()
protected _wrapPosition(i): numberWraps a value around the sample range boundaries
Parameters
| Parameter | Type | Description |
|---|---|---|
i | number | Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned. |
Returns
number
Wrapped position in sample range
Defined in
submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:249 (opens in a new tab)
add()
add(v): voidAdds a sample to the sample set
Parameters
| Parameter | Type | Description |
|---|---|---|
v | number | The sample value |
Returns
void
Defined in
submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:182 (opens in a new tab)
history()
history(i): numberReturns previously added values or null if outside of history or outside the sliding window domain
Parameters
| Parameter | Type | Description |
|---|---|---|
i | number | Index in history. For example, pass 0 for the most recent value and 1 for the value before that |
Returns
number
Value previously recorded with add() or null if outside of range
Defined in
submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:216 (opens in a new tab)
isSaturated()
isSaturated(): booleanReturns true if enough samples have been taken to completely fill the sliding window
Returns
boolean
true if sample-set saturated
Defined in
submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:229 (opens in a new tab)
reset()
reset(): voidResets the rolling average (equivalent to 0 samples taken so far)
Returns
void
Defined in
submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:236 (opens in a new tab)