# @stdlib/stats-iter-cugmean

0.2.1 • Public • Published

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!

# itercugmean

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.

## Installation

`npm install @stdlib/stats-iter-cugmean`

## Usage

`var itercugmean = require( '@stdlib/stats-iter-cugmean' );`

#### itercugmean( iterator )

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```

## Notes

• If an iterated value is non-numeric (including `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.

## Examples

```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;
}
}```

## 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.

## Package Sidebar

### Install

`npm i @stdlib/stats-iter-cugmean`

### Repository

github.com/stdlib-js/stats-iter-cugmean

stdlib.io

14

0.2.1

Apache-2.0

42.5 kB

12