stdlib-js/stats-iter-cumeanabs2Public

NotificationsYou must be signed in to change notification settings
Fork0
Star2

Create an iterator which iteratively computes a cumulative arithmetic mean of squared absolute values.

License

Apache-2.0 license

2 stars 0 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 64 Commits
.github		.github
benchmark		benchmark
dist		dist
docs		docs
examples		examples
lib		lib
test		test
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
.npmrc		.npmrc
CHANGELOG.md		CHANGELOG.md
CITATION.cff		CITATION.cff
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS		CONTRIBUTORS
LICENSE		LICENSE
Makefile		Makefile
NOTICE		NOTICE
README.md		README.md
SECURITY.md		SECURITY.md
branches.md		branches.md
package.json		package.json

Repository files navigation

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 considerfinancially supporting stdlib. We greatly appreciate your continued support!

itercumeanabs2

Create aniterator which iteratively computes a cumulativearithmetic mean of squared absolute values.

The cumulativearithmetic mean of squared absolute values is defined as

$$\bar{x}_n = \frac{1}{n} \sum_{i=0}^n x_i^2$$

Installation

npm install @stdlib/stats-iter-cumeanabs2

Alternatively,

To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).

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

Usage

varitercumeanabs2=require('@stdlib/stats-iter-cumeanabs2');

itercumeanabs2( iterator )

Returns aniterator which iteratively computes a cumulativearithmetic mean of squared absolute values.

vararray2iterator=require('@stdlib/array-to-iterator');vararr=array2iterator([2.0,1.0,3.0,-7.0,-5.0]);varit=itercumeanabs2(arr);varm=it.next().value;// returns 4.0m=it.next().value;// returns 2.5m=it.next().value;// returns ~4.67m=it.next().value;// returns 15.75m=it.next().value;// returns 17.6

Notes

If an iterated value is non-numeric (includingNaN), the function returnsNaN forall future iterations. If non-numeric iterated values are possible, you are advised to provide aniterator which type checks and handles non-numeric values accordingly.

Examples

varrunif=require('@stdlib/random-iter-uniform');varitercumeanabs2=require('@stdlib/stats-iter-cumeanabs2');// Create an iterator for generating uniformly distributed pseudorandom numbers:varrand=runif(-10.0,10.0,{'seed':1234,'iter':100});// Create an iterator for iteratively computing a cumulative mean of squared absolute values:varit=itercumeanabs2(rand);// Perform manual iteration...varv;while(true){v=it.next();if(typeofv.value==='number'){console.log('meanabs2: %d',v.value);}if(v.done){break;}}

Notice

This package is part ofstdlib, 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 developstdlib, see the main projectrepository.