@stdlib/stats-iter-sumabs
TypeScript icon, indicating that this package has built-in type declarations

0.2.2 • Public • Published
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!

itersumabs

NPM version Build Status Coverage Status

Compute the sum of absolute values for all iterated values.

The sum of absolute values is defined as

Equation for the sum of absolute values.

Installation

npm install @stdlib/stats-iter-sumabs

Usage

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

itersumabs( iterator )

Computes the sum of absolute values for all iterated values.

var array2iterator = require( '@stdlib/array-to-iterator' );

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

var s = itersumabs( arr );
// returns 10.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.
  • For iterators which can generate many values or which may output large numbers, care should be taken to prevent overflow.

Examples

var runif = require( '@stdlib/random-iter-uniform' );
var itersumabs = require( '@stdlib/stats-iter-sumabs' );

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

// Compute the sum of absolute values:
var s = itersumabs( rand );
// returns <number>

console.log( 'sumabs: %d.', s );

See Also


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/stats-iter-sumabs

Homepage

stdlib.io

Weekly Downloads

13

Version

0.2.2

License

Apache-2.0

Unpacked Size

34.8 kB

Total Files

12

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser