Class RollingAverage

constructor

• new RollingAverage(length: number): RollingAverage

  constructor

  Parameters

  • length: number

    The number of samples required to saturate the sliding window

  Returns RollingAverage

average

variance

add

• add(v: number): void

  Adds a sample to the sample set

  Parameters

  • v: number

    The sample value

  Returns void

history

• history(i: number): number

  Returns previously added values or null if outside of history or outside the sliding window domain

  Parameters

  • 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

isSaturated

• isSaturated(): boolean

  Returns true if enough samples have been taken to completely fill the sliding window

  Returns boolean

  true if sample-set saturated

reset

• reset(): void

  Resets the rolling average (equivalent to 0 samples taken so far)

  Returns void