@stdlib/stats-iter-sumabs
v0.2.2
Published
Compute the sum of absolute values for all iterated values.
Downloads
120
Readme
itersumabs
Compute the sum of absolute values for all iterated values.
The sum of absolute values is defined as
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 returnediterator
returnsNaN
. If non-numeric iterated values are possible, you are advised to provide aniterator
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
@stdlib/stats-iter/meanabs
: compute the arithmetic mean of absolute values for all iterated values.@stdlib/stats-iter/msumabs
: create an iterator which iteratively computes a moving sum of absolute values.@stdlib/stats-iter/sum
: compute the sum of all iterated values.
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.
Copyright
Copyright © 2016-2024. The Stdlib Authors.