@stdlib/stats-incr-sumprod

Compute a sum of products incrementally.

Usage no npm install needed!

<script type="module">
  import stdlibStatsIncrSumprod from 'https://cdn.skypack.dev/@stdlib/stats-incr-sumprod';
</script>

README

incrsumprod

NPM version Build Status Coverage Status

Compute a sum of products incrementally.

The sum of products is defined as

Equation for the sum of products.

Installation

npm install @stdlib/stats-incr-sumprod

Usage

var incrsumprod = require( '@stdlib/stats-incr-sumprod' );

incrsumprod()

Returns an accumulator function which incrementally computes a sum of products.

var accumulator = incrsumprod();

accumulator( [x, y] )

If provided input values x and y, the accumulator function returns an updated sum. If not provided input value x and y, the accumulator function returns the current sum.

var accumulator = incrsumprod();

var sum = accumulator( 2.0, 3.0 );
// returns 6.0

sum = accumulator( 1.0, -1.0 );
// returns 5.0

sum = accumulator( 3.0, 4.0 );
// returns 17.0

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

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

var accumulator;
var v1;
var v2;
var i;

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

// For each simulated datum, update the sum-product...
for ( i = 0; i < 100; i++ ) {
    v1 = randu() * 100.0;
    v2 = randu() * 100.0;
    accumulator( v1, v2 );
}
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-2022. The Stdlib Authors.