Package Exports

@stdlib/stats-iter-sumabs2

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-sumabs2) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

itersumabs2

Compute the sum of squared absolute values for all iterated values.

The sum of squared absolute values is defined as

Equation for the sum of squared absolute values.

Installation

npm install @stdlib/stats-iter-sumabs2

Usage

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

itersumabs2( iterator )

Computes the sum of squared absolute values for all iterated values.

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

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

var s = itersumabs2( arr );
// returns 30.0

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 itersumabs2 = require( '@stdlib/stats-iter-sumabs2' );

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

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

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

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.

License

See LICENSE.

@stdlib/stats-iter-sumabs2