npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

compute-euclidean-distance

v1.0.0

Published

Computes the Euclidean distance between two arrays.

Downloads

24

Readme

Euclidean Distance

NPM version Build Status Coverage Status Dependencies

Computes the Euclidean distance between two arrays.

The Euclidean distance is the straight line distance between two points in Euclidean space.

Installation

$ npm install compute-euclidean-distance

For use in the browser, use browserify.

Usage

var euclidean = require( 'compute-euclidean-distance' );

euclidean( x, y[, accessor] )

Computes the Euclidean distance between two arrays.

var x = [ 2, 4, 5, 3, 8, 2 ],
	y = [ 3, 1, 5, -3, 7, 2 ];

var d = euclidean( x, y );
// returns ~6.86

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

var x, y, d;

x = [
	[1,2],
	[2,4],
	[3,5],
	[4,3],
	[5,8],
	[6,2]
];

y = [
	{'y':3},
	{'y':1},
	{'y':5},
	{'y':-3},
	{'y':7},
	{'y':2}
];

function getValue( d, i, j ) {
	if ( j === 0 ) {
		return d[ 1 ];
	}
	return d.y;
}

d = euclidean( x, y, getValue );
// returns ~6.86

The accessor function is provided three arguments:

  • d: current datum.
  • i: current datum index.
  • j: array index; e.g., array x has index 0, and array y has index 1.

If provided empty arrays, the function returns null.

Examples

var euclidean = require( 'compute-euclidean-distance' );

var x = new Array( 100 ),
	y = new Array( 100 );

for ( var i = 0; i < x.length; i++ ) {
	x[ i ] = Math.round( Math.random()*10 );
	y[ i ] = Math.round( Math.random()*10 );
}

console.log( euclidean( x, y ) );

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.

Copyright

Copyright © 2015. Athan Reines.