Package Exports

compute-l2norm

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

Readme

L2 norm

Computes the L2 norm (Euclidean norm) of an array.

Installation

$ npm install compute-l2norm

For use in the browser, use browserify.

Usage

var l2norm = require( 'compute-l2norm' );

l2norm( arr[, accessor] )

Computes the L2 norm (Euclidean norm) of an array.

var data = [ 2, 7, 3, -3, 9 ];

var norm = l2norm( data );
// returns ~12.3288

For object arrays, provide an accessor function for accessing array values.

var data = [
    ['beep', 3],
    ['boop', 4]
];

function getValue( d, i ) {
    return d[ 1 ];
}

var norm = l2norm( data, getValue );
// returns 5

If provided an empty array, the function returns null.

Examples

var l2norm = require( 'compute-l2norm' );

var data = new Array( 1000 );
for ( var i = 0; i < data.length; i++ ) {
    data[ i ] = Math.random() * 100;
}

console.log( l2norm( data ) );

To run the example code from the top-level application directory,

$ node ./examples/index.js

References

Dahlquist, Germund and Bjorck, Ake. _Numerical Methods in Scientific Computing_.

Blue, James (1978) "A Portable Fortran Program To Find the Euclidean Norm of a Vector". _ACM Transactions on Mathematical Software_.

Higham, Nicholas J. _Accuracy and Stability of Numerical Algorithms, Second Edition_.

This module implements a one-pass algorithm proposed by S.J. Hammarling.

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

compute-l2norm