@stdlib/stats-incr-msumabs2
v0.2.3TypeScript
Compute a moving sum of squared absolute values incrementally.
0/weekUpdated yesterdayApache-2.0Unpacked: 38.2 KB
Published by The Stdlib Authors
npm install @stdlib/stats-incr-msumabs2We 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!
About stdlib...
incrmsumabs2
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute a moving sum of squared absolute values incrementally.
For a window of size W, the moving sum of squared absolute values is defined as
Installation
``bash`
npm install @stdlib/stats-incr-msumabs2
Usage
`javascript`
var incrmsumabs2 = require( '@stdlib/stats-incr-msumabs2' );
#### incrmsumabs2( window )
Returns an accumulator function which incrementally computes a moving sum of squared absolute values. The window parameter defines the number of values over which to compute the moving sum.
`javascript`
var accumulator = incrmsumabs2( 3 );
#### accumulator( \[x] )
If provided an input value x, the accumulator function returns an updated sum. If not provided an input value x, the accumulator function returns the current sum.
`javascript
var accumulator = incrmsumabs2( 3 );
var sum = accumulator();
// returns null
// Fill the window...
sum = accumulator( 2.0 ); // [2.0]
// returns 4.0
sum = accumulator( -1.0 ); // [2.0, -1.0]
// returns 5.0
sum = accumulator( 3.0 ); // [2.0, -1.0, 3.0]
// returns 14.0
// Window begins sliding...
sum = accumulator( -7.0 ); // [-1.0, 3.0, -7.0]
// returns 59.0
sum = accumulator( -5.0 ); // [3.0, -7.0, -5.0]
// returns 83.0
sum = accumulator();
// returns 83.0
`
Notes
- Input values are not type checked. If provided NaN or a value which, when used in computations, results in 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.W
- As 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 incrmsumabs2 = require( '@stdlib/stats-incr-msumabs2' );
var accumulator;
var v;
var i;
// Initialize an accumulator:
accumulator = incrmsumabs2( 5 );
// For each simulated datum, update the moving sum...
for ( i = 0; i < 100; i++ ) {
v = ( randu()*100.0 ) - 50.0;
accumulator( v );
}
console.log( accumulator() );
`
*
See Also
- [@stdlib/stats-incr/mmeanabs2][@stdlib/stats/incr/mmeanabs2]: compute a moving arithmetic mean of squared absolute values incrementally.
- [@stdlib/stats-incr/msumabs][@stdlib/stats/incr/msumabs]: compute a moving sum of absolute values incrementally.
- [@stdlib/stats-incr/sumabs][@stdlib/stats/incr/sumabs]: compute a sum of absolute values incrementally.
- [@stdlib/stats-incr/sumabs2][@stdlib/stats/incr/sumabs2]: compute a sum of squared absolute values 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-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-incr-msumabs2.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-incr-msumabs2
[test-image]: https://github.com/stdlib-js/stats-incr-msumabs2/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/stats-incr-msumabs2/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-incr-msumabs2/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-incr-msumabs2?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[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-msumabs2/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-incr-msumabs2/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-incr-msumabs2/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-incr-msumabs2/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-incr-msumabs2/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-incr-msumabs2/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-incr-msumabs2/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-incr-msumabs2/main/LICENSE
[@stdlib/stats/incr/mmeanabs2]: https://www.npmjs.com/package/@stdlib/stats-incr-mmeanabs2
[@stdlib/stats/incr/msumabs]: https://www.npmjs.com/package/@stdlib/stats-incr-msumabs
[@stdlib/stats/incr/sumabs]: https://www.npmjs.com/package/@stdlib/stats-incr-sumabs
[@stdlib/stats/incr/sumabs2]: https://www.npmjs.com/package/@stdlib/stats-incr-sumabs2