GithubHelp home page GithubHelp logo

fabionl / haversine Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kristianmandrup/haversine

0.0 0.0 0.0 27 KB

Calculates the haversine distance between two locations using longitude and latitude

License: MIT License

Ruby 100.00%

haversine's Introduction

Haversine Distance

This gem calculates the Haversine distance between two points given their longitude and latitude. This is done using trigonometry without ActiveRecord or SQL. See http://en.wikipedia.org/wiki/Haversine_formula for details on the Haversine formula.

This is a replacement for all geo libraries that use built-in SQL DB functionality for their calculations.

Install & Usage

Install this gem with gem install haversine. Calling Haversine.distance with four lat/lon coordinates returns a Haversine::Distance object which can provide output in kilometers, meters, miles, or feet.

require 'haversine'

distance = Haversine.distance(35.61488, 139.5813, 48.85341, 2.3488)

distance.class => Haversine::Distance
distance.to_miles => 6032.71091869803
distance.to_kilometers => 9715.47049115903
distance.to_meters => 9715470.49115903
distance.to_feet => 31852713.6507256
distance.to_nautical_miles => 5242.2799481204265

Convenience aliases for the measurements exist:


distance.to_kilometers == distance.to_km
distance.to_meters == distance.to_m
distance.to_miles == distance.to_mi
distance.to_feet == distance.to_ft
distance.to_nautical_miles == distance.to_nm

Note that to_m is the distance in meters, not miles.

If you have lat/lon pairs stored in an array, you can alternately provide two arrays when calling Haversine.distance:

require 'haversine'
new_york_city = [40.71427, -74.00597]
santiago_chile = [-33.42628, -70.56656]
Haversine.distance(new_york_city, santiago_chile).to_miles => 5123.73

Note: Haversine is used in the geo_magic gem

Contributing to haversine

  • Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet
  • Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright © 2011 Kristian Mandrup. See LICENSE.txt for
further details.

haversine's People

Contributors

kristianmandrup avatar ryangreenberg avatar styd avatar tkrajcar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.