@stdlib/stats-incr-nansumabs2
v0.2.3TypeScript
Compute a sum of squared absolute values incrementally, ignoring NaN values.
0/weekUpdated 4 days agoApache-2.0Unpacked: 35.2 KB
Published by The Stdlib Authors
npm install @stdlib/stats-incr-nansumabs2We 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...
incrnansumabs2
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute a sum of squared absolute values incrementally, ignoring NaN values.
The sum of squared absolute values is defined as
Installation
``bash`
npm install @stdlib/stats-incr-nansumabs2
Usage
`javascript`
var incrnansumabs2 = require( '@stdlib/stats-incr-nansumabs2' );
#### incrnansumabs2()
Returns an accumulator function which incrementally computes a sum of squared absolute values, ignoring NaN values.
`javascript`
var accumulator = incrnansumabs2();
#### 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 = incrnansumabs2();
var sum = accumulator( 2.0 );
// returns 4.0
sum = accumulator( -1.0 );
// returns 5.0
sum = accumulator( NaN );
// returns 5.0
sum = accumulator( -3.0 );
// returns 14.0
sum = accumulator();
// returns 14.0
`
Notes
- Input values are not type checked. If non-numeric inputs are possible, you are advised to type check and handle accordingly before passing the value to the accumulator function.
- For long running accumulations or accumulations of large numbers, care should be taken to prevent overflow.
Examples
`javascript
var randu = require( '@stdlib/random-base-randu' );
var incrnansumabs2 = require( '@stdlib/stats-incr-nansumabs2' );
var accumulator;
var v;
var i;
// Initialize an accumulator:
accumulator = incrnansumabs2();
// For each simulated datum, update the sum...
for ( i = 0; i < 100; i++ ) {
v = ( randu()*100.0 ) - 50.0;
accumulator( v );
}
console.log( accumulator() );
`
*
See Also
- [@stdlib/stats-incr/nansum][@stdlib/stats/incr/nansum]: compute a sum incrementally, ignoring NaN values.
- [@stdlib/stats-incr/nansumabs][@stdlib/stats/incr/nansumabs]: compute a sum of absolute values incrementally, ignoring NaN values.
- [@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-nansumabs2.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-incr-nansumabs2
[test-image]: https://github.com/stdlib-js/stats-incr-nansumabs2/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/stats-incr-nansumabs2/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-incr-nansumabs2/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-incr-nansumabs2?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-nansumabs2/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-incr-nansumabs2/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-incr-nansumabs2/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-incr-nansumabs2/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-incr-nansumabs2/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-incr-nansumabs2/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-incr-nansumabs2/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-incr-nansumabs2/main/LICENSE
[@stdlib/stats/incr/nansum]: https://www.npmjs.com/package/@stdlib/stats-incr-nansum
[@stdlib/stats/incr/nansumabs]: https://www.npmjs.com/package/@stdlib/stats-incr-nansumabs
[@stdlib/stats/incr/sumabs2]: https://www.npmjs.com/package/@stdlib/stats-incr-sumabs2