@stdlib/stats-incr-sum
v0.2.3TypeScript
Compute a sum incrementally.
5.3K/weekUpdated 5 days agoApache-2.0Unpacked: 36.1 KB
Published by The Stdlib Authors
npm install @stdlib/stats-incr-sumWe 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...
incrsum
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute a sum incrementally.
The sum is defined as
Installation
``bash`
npm install @stdlib/stats-incr-sum
Usage
`javascript`
var incrsum = require( '@stdlib/stats-incr-sum' );
#### incrsum()
Returns an accumulator function which incrementally computes a sum.
`javascript`
var accumulator = incrsum();
#### 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 = incrsum();
var sum = accumulator( 2.0 );
// returns 2.0
sum = accumulator( 1.0 );
// returns 3.0
sum = accumulator( 3.0 );
// returns 6.0
sum = accumulator();
// returns 6.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 all 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.
- 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 incrsum = require( '@stdlib/stats-incr-sum' );
var accumulator;
var v;
var i;
// Initialize an accumulator:
accumulator = incrsum();
// For each simulated datum, update the sum...
for ( i = 0; i < 100; i++ ) {
v = randu() * 100.0;
accumulator( v );
}
console.log( accumulator() );
`
*
References
- Klein, Andreas. 2005. "A Generalized Kahan-Babuška-Summation-Algorithm." _Computing_ 76 (3): 279–93. doi:[10.1007/s00607-005-0139-x][@klein:2005a].
*
See Also
- [@stdlib/stats-incr/count][@stdlib/stats/incr/count]: compute a count incrementally.
- [@stdlib/stats-incr/mean][@stdlib/stats/incr/mean]: compute an arithmetic mean incrementally.
- [@stdlib/stats-incr/msum][@stdlib/stats/incr/msum]: compute a moving sum incrementally.
- [@stdlib/stats-incr/prod][@stdlib/stats/incr/prod]: compute a product incrementally.
- [@stdlib/stats-incr/summary][@stdlib/stats/incr/summary]: compute a statistical summary 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-sum.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-incr-sum
[test-image]: https://github.com/stdlib-js/stats-incr-sum/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/stats-incr-sum/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-incr-sum/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-incr-sum?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-sum/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-incr-sum/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-incr-sum/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-incr-sum/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-incr-sum/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-incr-sum/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-incr-sum/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-incr-sum/main/LICENSE
[@klein:2005a]: https://doi.org/10.1007/s00607-005-0139-x
[@stdlib/stats/incr/count]: https://www.npmjs.com/package/@stdlib/stats-incr-count
[@stdlib/stats/incr/mean]: https://www.npmjs.com/package/@stdlib/stats-incr-mean
[@stdlib/stats/incr/msum]: https://www.npmjs.com/package/@stdlib/stats-incr-msum
[@stdlib/stats/incr/prod]: https://www.npmjs.com/package/@stdlib/stats-incr-prod
[@stdlib/stats/incr/summary]: https://www.npmjs.com/package/@stdlib/stats-incr-summary