@stdlib/stats-incr-nansum
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
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!

incrnansum

NPM version Build Status Coverage Status

Compute a sum incrementally, ignoring NaN values.

The sum is defined as

Equation for the sum.

Installation

npm install @stdlib/stats-incr-nansum

Usage

var incrnansum = require( '@stdlib/stats-incr-nansum' );

incrnansum()

Returns an accumulator function which incrementally computes a sum, ignoring NaN values.

var accumulator = incrnansum();

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.

var accumulator = incrnansum();

var sum = accumulator( 2.0 );
// returns 2.0

sum = accumulator( 1.0 );
// returns 3.0

sum = accumulator( NaN );
// returns 3.0

sum = accumulator( 3.0 );
// returns 6.0

sum = accumulator();
// returns 6.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

var randu = require( '@stdlib/random-base-randu' );
var incrnansum = require( '@stdlib/stats-incr-nansum' );

var accumulator;
var v;
var i;

// Initialize an accumulator:
accumulator = incrnansum();

// For each simulated datum, update the sum...
for ( i = 0; i < 100; i++ ) {
    if ( randu() < 0.2 ) {
        v = NaN;
    } else {
        v = randu() * 100.0;
    }
    accumulator( v );
}
console.log( accumulator() );

See Also


Notice

This package is part of 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, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/stats-incr-nansum

Homepage

stdlib.io

Weekly Downloads

11

Version

0.2.1

License

Apache-2.0

Unpacked Size

33.5 kB

Total Files

12

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser