Skip to content

Latest commit

 

History

History
250 lines (149 loc) · 8.82 KB

README.md

File metadata and controls

250 lines (149 loc) · 8.82 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!

itermeanabs

NPM version Build Status Coverage Status

Compute the arithmetic mean of absolute values for all iterated values.

The arithmetic mean of absolute values is defined as

$$\mu = \frac{1}{n} \sum_{i=0}^{n-1} |x_i|$$

Usage

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

itermeanabs( iterator )

Computes the arithmetic mean of absolute values for all iterated values.

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

var arr = array2iterator( [ 1.0, -2.0, -3.0, 4.0 ] );

var m = itermeanabs( arr );
// returns 2.5

Notes

  • If an iterated value is non-numeric (including NaN), the returned iterator returns NaN. If non-numeric iterated values are possible, you are advised to provide an iterator which type checks and handles non-numeric values accordingly.

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 itermeanabs from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-iter-meanabs@esm/index.mjs';

// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( -10.0, 10.0, {
    'seed': 1234,
    'iter': 100
});

// Compute the arithmetic mean of absolute values:
var m = itermeanabs( rand );
// returns <number>

console.log( 'meanabs: %d.', m );

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