abpetkov / euclidean

Calculates the distance between two points.

Home Page:http://pazguille.github.io/euclidean/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Euclidean

In mathematics, the Euclidean distance or Euclidean metric is the "ordinary" distance between two points that one would measure with a ruler, and is given by the Pythagorean formula. Read More.

Installation

$ component install pazguille/euclidean

See: https://github.com/component/component

Standalone

Also, you can use the standalone version:

<script src="euclidean.js"></script>

How-to

Defined two points:

var pointA = {
    'x': 2,
    'y': 4
};

var pointB = {
    'x': 8,
    'y': 16
};

Calculate distante between pointA and pointB:

euclidean(pointA, pointB);

API

euclidean(p1, p2)

Calculate distance between two points.

  • p1 - A given point with coordenates xy.
  • p2 - A given point with coordenates xy.
euclidean(pointA, pointB);

Contact

License

The MIT License

Copyright (c) 2013 @pazguille

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Calculates the distance between two points.

http://pazguille.github.io/euclidean/


Languages

Language:JavaScript 100.0%