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!
Compute a sum incrementally.
The sum is defined as
import incrsum from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-incr-sum@esm/index.mjs';
Returns an accumulator function
which incrementally computes a sum.
var accumulator = incrsum();
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.
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
- Input values are not type checked. If provided
NaN
or a value which, when used in computations, results inNaN
, the accumulated value isNaN
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.
<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">
import randu from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-randu@esm/index.mjs';
import incrsum from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-incr-sum@esm/index.mjs';
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() );
</script>
</body>
</html>
- Klein, Andreas. 2005. "A Generalized Kahan-Babuška-Summation-Algorithm." Computing 76 (3): 279–93. doi:10.1007/s00607-005-0139-x.
@stdlib/stats-incr/count
: compute a count incrementally.@stdlib/stats-incr/mean
: compute an arithmetic mean incrementally.@stdlib/stats-incr/msum
: compute a moving sum incrementally.@stdlib/stats-incr/prod
: compute a product incrementally.@stdlib/stats-incr/summary
: compute a statistical summary incrementally.
This package is part of stdlib, a standard library 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, see the main project repository.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.