haversort
An implementation of a haversine algorhythm for finding the distance, in KM, between two latitudes and longtudes on Earth.
Usage
npm install -S haversort
> var h = ;> h; 12 12 312 13 13 4675 14 14 6228 18 18 12403 > h;15465API
-
distanceSort(lat, lon, points) → {array}
-
Given a point and a list of points, returns the list sorted by distance (closest first)
Parameters:
Name Type Description latmixed Lat of center point or array of
[lat, lon]representing the center pointlonmixed Lon of center point or array of points to sort
pointsarray Array of points to sort
Returns:
Array of points, sorted by distance from center point, with the distance pushed as the last element in each array
- Type
- array
-
haversine(lat1, lon1, lat2, lon2) → {number}
-
Compute the distance between two points using the haversine formula, based on the above defined Radius.
Parameters:
Name Type Argument Description lat1mixed First lat, or an array of
[lat, lon]representing the first pointlon1mixed First lon, or an array of
[lat, lon]resresenting the second pointlat2number <optional>
The latitude of the second point
lon2number <optional>
The longitude of the second point
Returns:
The distance, in KM, between the two points, rounded to the tenths.
- Type
- number
-
toRad(num) → {number}
-
Give that trig function a radian. Trig functions LOVE radians
Parameters:
Name Type Description numnumber Angle, in degrees to return as a Radian
Returns:
The radian for that angle.
- Type
- number
generated with docme
License & Copyright
Copyright (c) 2014 Todd Kennedy, licensed under the MIT License