https://github.com/stdlib-js/stats-incr-mrange
Compute a moving range incrementally.
https://github.com/stdlib-js/stats-incr-mrange
accumulator dispersion domain extent incremental javascript math mathematics max maximum min minimum node node-js nodejs range statistics stats stdlib variance
Last synced: 7 months ago
JSON representation
Compute a moving range incrementally.
- Host: GitHub
- URL: https://github.com/stdlib-js/stats-incr-mrange
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T16:11:49.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T07:58:58.000Z (10 months ago)
- Last Synced: 2025-02-01T16:48:59.189Z (8 months ago)
- Topics: accumulator, dispersion, domain, extent, incremental, javascript, math, mathematics, max, maximum, min, minimum, node, node-js, nodejs, range, statistics, stats, stdlib, variance
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 938 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# incrmrange
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute a moving [range][range] incrementally.
The [**range**][range] is defined as the difference between the maximum and minimum values.
## Installation
```bash
npm install @stdlib/stats-incr-mrange
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var incrmrange = require( '@stdlib/stats-incr-mrange' );
```
#### incrmrange( window )
Returns an accumulator `function` which incrementally computes a moving [range][range]. The `window` parameter defines the number of values over which to compute the moving [range][range].
```javascript
var accumulator = incrmrange( 3 );
```
#### accumulator( \[x] )
If provided an input value `x`, the accumulator function returns an updated [range][range]. If not provided an input value `x`, the accumulator function returns the current [range][range].
```javascript
var accumulator = incrmrange( 3 );
var r = accumulator();
// returns null
// Fill the window...
r = accumulator( 2.0 ); // [2.0]
// returns 0.0
r = accumulator( 1.0 ); // [2.0, 1.0]
// returns 1.0
r = accumulator( 3.0 ); // [2.0, 1.0, 3.0]
// returns 2.0
// Window begins sliding...
r = accumulator( -7.0 ); // [1.0, 3.0, -7.0]
// returns 10.0
r = accumulator( -5.0 ); // [3.0, -7.0, -5.0]
// returns 10.0
r = accumulator();
// returns 10.0
```
## Notes
- Input values are **not** type checked. If provided `NaN`, the accumulated value is `NaN` for **at least** `W-1` future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
- As `W` values are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.
## Examples
```javascript
var randu = require( '@stdlib/random-base-randu' );
var incrmrange = require( '@stdlib/stats-incr-mrange' );
var accumulator;
var v;
var i;
// Initialize an accumulator:
accumulator = incrmrange( 5 );
// For each simulated datum, update the moving range...
for ( i = 0; i < 100; i++ ) {
v = randu() * 100.0;
accumulator( v );
}
console.log( accumulator() );
```
* * *
## See Also
- [`@stdlib/stats-incr/mmax`][@stdlib/stats/incr/mmax]: compute a moving maximum incrementally.
- [`@stdlib/stats-incr/mmean`][@stdlib/stats/incr/mmean]: compute a moving arithmetic mean incrementally.
- [`@stdlib/stats-incr/mmin`][@stdlib/stats/incr/mmin]: compute a moving minimum incrementally.
- [`@stdlib/stats-incr/msummary`][@stdlib/stats/incr/msummary]: compute a moving statistical summary incrementally.
- [`@stdlib/stats-incr/range`][@stdlib/stats/incr/range]: compute a range incrementally.
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-incr-mrange.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-incr-mrange
[test-image]: https://github.com/stdlib-js/stats-incr-mrange/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/stats-incr-mrange/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-incr-mrange/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-incr-mrange?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/stats-incr-mrange/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-incr-mrange/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-incr-mrange/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-incr-mrange/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-incr-mrange/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-incr-mrange/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-incr-mrange/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-incr-mrange/main/LICENSE
[range]: https://en.wikipedia.org/wiki/Range_%28statistics%29
[@stdlib/stats/incr/mmax]: https://github.com/stdlib-js/stats-incr-mmax
[@stdlib/stats/incr/mmean]: https://github.com/stdlib-js/stats-incr-mmean
[@stdlib/stats/incr/mmin]: https://github.com/stdlib-js/stats-incr-mmin
[@stdlib/stats/incr/msummary]: https://github.com/stdlib-js/stats-incr-msummary
[@stdlib/stats/incr/range]: https://github.com/stdlib-js/stats-incr-range