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!
Create an iterator which iteratively computes a moving product.
For a window of size W, the moving product is defined as
npm install @stdlib/stats-iter-mprodAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch (see README). - If you are using Deno, visit the
denobranch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch (see README).
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var itermprod = require( '@stdlib/stats-iter-mprod' );Returns an iterator which iteratively computes a moving product. The W parameter defines the number of iterated values over which to compute the moving product.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 2.0, 1.0, 3.0, -7.0, -5.0 ] );
var it = itermprod( arr, 3 );
// Fill the window...
var p = it.next().value; // [2.0]
// returns 2.0
p = it.next().value; // [2.0, 1.0]
// returns 2.0
p = it.next().value; // [2.0, 1.0, 3.0]
// returns 6.0
// Window begins sliding...
p = it.next().value; // [1.0, 3.0, -7.0]
// returns -21.0
p = it.next().value; // [3.0, -7.0, -5.0]
// returns 105.0- If an iterated value is non-numeric (including
NaN), the function returnsNaNfor at leastW-1future invocations. If non-numeric iterated values are possible, you are advised to provide aniteratorwhich type checks and handles non-numeric values accordingly. - As
Wvalues are needed to fill the window buffer, the firstW-1returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all previously iterated values.
var runif = require( '@stdlib/random-iter-uniform' );
var itermprod = require( '@stdlib/stats-iter-mprod' );
// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( -10.0, 10.0, {
'seed': 1234,
'iter': 100
});
// Create an iterator for iteratively computing a moving product:
var it = itermprod( rand, 3 );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
if ( typeof v.value === 'number' ) {
console.log( 'product: %d', v.value );
}
}@stdlib/stats-iter/msum: create an iterator which iteratively computes a moving sum.@stdlib/stats-iter/prod: compute the product of all iterated values.
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.
