JSPM

live-moving-average

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 37
  • Score
    100M100P100Q72891F
  • License ISC

An ever updating average of the last n values.

Package Exports

  • live-moving-average

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (live-moving-average) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

live-moving-average

An ever updating average of the last n values. See Moving Average.

npm version build status ISC-licensed minimum Node.js version chat with me on Gitter support me via GitHub Sponsors

Reuses the values array to prevent GC-thrashing. Does not slow down with an increasing window size:

window size 10, 1 push, 10 get x 49,988,485 ops/sec ±0.28% (93 runs sampled)
window size 1000, 1 push, 1 get x 64,048,288 ops/sec ±0.42% (93 runs sampled)
window size 100, 1 push, 10 get x 49,012,149 ops/sec ±0.40% (95 runs sampled)

Installing

npm install live-moving-average

Usage

const createWindow = require('live-moving-average')

const avg = createWindow(3, 0) // size of 3, fill with 0

avg.push(2)
avg.push(3)
avg.push(4)
avg.get() // 3, because (2 + 3 + 4) / 3

avg.push(5)
avg.push(6)
avg.get() // 5, because (4 + 5 + 6) / 3

avg.push(7)
avg.get() // 6, because (5 + 6 + 7) / 3

API

const w = createWindow(size, fill = 0)

size and fill must be a number.

w.push(val)

val must be a number.

w.get()

Returns the moving average.

Contributing

If you have a question or need support using live-moving-average, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, use the issues page.