Create an iterator which iteratively computes a cumulative geometric mean.
APACHE-2.0 License
Create an iterator which iteratively computes a cumulative geometric mean.
The geometric mean is defined as the nth root of a product of n numbers.
\biggl( \prod_{i=0}^{n-1} \biggr)^{\frac{1}{n}} = \sqrt[n]{x_0 x_1 \cdots x_{n-1}}
npm install @stdlib/stats-iter-cugmean
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).umd
branch (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 itercugmean = require( '@stdlib/stats-iter-cugmean' );
Returns an iterator which iteratively computes a cumulative geometric mean.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 2.0, 1.0, 3.0, 7.0, 5.0 ] );
var it = itercugmean( arr );
var v = it.next().value;
// returns 2.0
v = it.next().value;
// returns ~1.41
v = it.next().value;
// returns ~1.82
v = it.next().value;
// returns ~2.55
v = it.next().value;
// returns ~2.91
NaN
) or negative, the function returns NaN
for all future iterations. If non-numeric and/or negative iterated values are possible, you are advised to provide an iterator
which type checks and handles such values accordingly.var runif = require( '@stdlib/random-iter-uniform' );
var itercugmean = require( '@stdlib/stats-iter-cugmean' );
// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( 0.0, 10.0, {
'seed': 1234,
'iter': 100
});
// Create an iterator for iteratively computing a cumulative geometric mean:
var it = itercugmean( rand );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( typeof v.value === 'number' ) {
console.log( 'gmean: %d', v.value );
}
if ( v.done ) {
break;
}
}
@stdlib/stats-iter/cuhmean
: create an iterator which iteratively computes a cumulative harmonic mean.
@stdlib/stats-iter/cumean
: create an iterator which iteratively computes a cumulative arithmetic mean.
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.