Package Exports

@stdlib/stats-iter
@stdlib/stats-iter/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/stats-iter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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!

Iterator Statistics

Statistical function iterators.

Installation

npm install @stdlib/stats-iter

Usage

var ns = require( '@stdlib/stats-iter' );

ns

Namespace containing functions for computing statistics over iterators.

var o = ns;
// returns {...}

itercugmean( iterator ): create an iterator which iteratively computes a cumulative geometric mean.
itercuhmean( iterator ): create an iterator which iteratively computes a cumulative harmonic mean.
itercumax( iterator ): create an iterator which iteratively computes a cumulative maximum value.
itercumaxabs( iterator ): create an iterator which iteratively computes a cumulative maximum absolute value.
itercumean( iterator ): create an iterator which iteratively computes a cumulative arithmetic mean.
itercumeanabs( iterator ): create an iterator which iteratively computes a cumulative arithmetic mean of absolute values.
itercumeanabs2( iterator ): create an iterator which iteratively computes a cumulative arithmetic mean of squared absolute values.
itercumidrange( iterator ): create an iterator which iteratively computes a cumulative mid-range.
itercumin( iterator ): create an iterator which iteratively computes a cumulative minimum value.
itercuminabs( iterator ): create an iterator which iteratively computes a cumulative minimum absolute value.
itercuprod( iterator ): create an iterator which iteratively computes a cumulative product.
itercurange( iterator ): create an iterator which iteratively computes a cumulative range.
itercusum( iterator ): create an iterator which iteratively computes a cumulative sum.
itercusumabs( iterator ): create an iterator which iteratively computes a cumulative sum of absolute values.
itercusumabs2( iterator ): create an iterator which iteratively computes a cumulative sum of squared absolute values.
itermax( iterator ): compute the maximum value of all iterated values.
itermaxabs( iterator ): compute the maximum absolute value of all iterated values.
itermean( iterator ): compute the arithmetic mean over all iterated values.
itermeanabs( iterator ): compute the arithmetic mean of absolute values for all iterated values.
itermeanabs2( iterator ): compute the arithmetic mean of squared absolute values for all iterated values.
itermidrange( iterator ): compute the mid-range of all iterated values.
itermin( iterator ): compute the minimum value of all iterated values.
iterminabs( iterator ): compute the minimum absolute value of all iterated values.
itermmax( iterator, W ): create an iterator which iteratively computes a moving maximum value.
itermmaxabs( iterator, W ): create an iterator which iteratively computes a moving maximum absolute value.
itermmean( iterator, W ): create an iterator which iteratively computes a moving arithmetic mean.
itermmeanabs( iterator, W ): create an iterator which iteratively computes a moving arithmetic mean of absolute values.
itermmeanabs2( iterator, W ): create an iterator which iteratively computes a moving arithmetic mean of squared absolute values.
itermmidrange( iterator, W ): create an iterator which iteratively computes a moving mid-range.
itermmin( iterator, W ): create an iterator which iteratively computes a moving minimum value.
itermminabs( iterator, W ): create an iterator which iteratively computes a moving minimum absolute value.
itermprod( iterator, W ): create an iterator which iteratively computes a moving product.
itermrange( iterator, W ): create an iterator which iteratively computes a moving range.
itermsum( iterator, W ): create an iterator which iteratively computes a moving sum.
itermsumabs( iterator, W ): create an iterator which iteratively computes a moving sum of absolute values.
itermsumabs2( iterator, W ): create an iterator which iteratively computes a moving sum of squared absolute values.
iterprod( iterator ): compute the product of all iterated values.
iterrange( iterator ): compute the range of all iterated values.
iterstdev( iterator[, mean] ): compute the corrected sample standard deviation over all iterated values.
itersum( iterator ): compute the sum of all iterated values.
itersumabs( iterator ): compute the sum of absolute values for all iterated values.
itersumabs2( iterator ): compute the sum of squared absolute values for all iterated values.
itervariance( iterator[, mean] ): compute the unbiased sample variance over all iterated values.

Examples

var getKeys = require( '@stdlib/utils-keys' );
var ns = require( '@stdlib/stats-iter' );

console.log( getKeys( ns ) );

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

License

See LICENSE.

@stdlib/stats-iter