Skip to content

Latest commit

 

History

History
268 lines (165 loc) · 9.06 KB

README.md

File metadata and controls

268 lines (165 loc) · 9.06 KB
Raw
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!

itercuprod

NPM version Build Status Coverage Status

Create an iterator which iteratively computes a cumulative product.

The cumulative product is defined as

$$\begin{align*} p_0 &= x_0 \\ p_1 &= x_1 \cdot p_0 \\ p_2 &= x_2 \cdot p_1 \\ p_n &= x_n \cdot p_{n-1} = x_n \cdot \prod_{i=0}^{n-1} x_i \end{align*}$$

Usage

import itercuprod from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-iter-cuprod@esm/index.mjs';

itercuprod( iterator )

Returns an iterator which iteratively computes a cumulative product.

import array2iterator from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-to-iterator@esm/index.mjs';

var arr = array2iterator( [ 2.0, 1.0, 3.0, -7.0, -5.0 ] );
var it = itercuprod( arr );

var p = it.next().value;
// returns 2.0

p = it.next().value;
// returns 2.0

p = it.next().value;
// returns 6.0

p = it.next().value;
// returns -42.0

p = it.next().value;
// returns 210.0

Notes

  • If an iterated value is non-numeric (including NaN), the function returns NaN for all future iterations. If non-numeric iterated values are possible, you are advised to provide an iterator which type checks and handles non-numeric values accordingly.
  • For iterators which can generate many values or which may output large numbers, care should be taken to prevent overflow.

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">

import runif from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-iter-uniform@esm/index.mjs';
import itercuprod from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-iter-cuprod@esm/index.mjs';

// 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 cumulative product:
var it = itercuprod( rand );

// Perform manual iteration...
var v;
while ( true ) {
    v = it.next();
    if ( typeof v.value === 'number' ) {
        console.log( 'prod: %d', v.value );
    }
    if ( v.done ) {
        break;
    }
}

</script>
</body>
</html>

See Also

Notice

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.

Community

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.