haversine_fast 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4abf62c56c93b58bdda0021578e9d554db0dd317
+  data.tar.gz: 73596d5a88494025edcc4c0cff72b329df64e56d
+SHA512:
+  metadata.gz: 68b72d9e87b7cdb25b0b4306bac87b77fdb9439cd8b10259b7df18d429b27f1abd954becd7968a78709eb0edfd1a950df9af646faa6003d0e52ab70532cda639
+  data.tar.gz: 9d63ae95b867a943e3809e454b9d44789dd355a3ced9bd9174529d1d86ed529e665ae681b08ac6b2dbd171eab72154f95a05d0287e03d17412110e1dd699c17b

data/.gitignore

@@ -0,0 +1,27 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+
+
+#ignore coveragge
+coverage/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in haversine_fast.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Shaun Hubbard
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,36 @@
+# HaversineFast
+
+This takes advantage of C being faster at calculating double floating point values then say ruby. A project necessitated the haversine calculation frequently which would be sub optimal in ruby. There were gems that I found that did this which were either old (2+ years,) or they ran on ruby which defeated the purpose, or did a lot more then just calculate the minimum distance between two points on an ellipsoid. Either way this was a nice exercise to remove external dependencies and optimize a continuous calculation.
+
+
+Per [wikipedia:](http://en.wikipedia.org/wiki/Haversine_formula)
+
+
+<a href="http://www.codecogs.com/eqnedit.php?latex=haversine\left&space;(&space;\frac{d}{r}&space;\right&space;)&space;=&space;haversin\left&space;(&space;\phi&space;_{2}&space;-&space;\phi&space;_{1}&space;\right&space;)&space;&plus;&space;cos\left&space;(&space;\phi&space;_{1}&space;\right&space;)cos\left&space;(&space;\phi&space;_{2}&space;\right&space;)haversin\left&space;(&space;\lambda&space;_{2}&space;-&space;\lambda&space;_{1}&space;\right&space;)" target="_blank"><img src="http://latex.codecogs.com/gif.latex?haversine\left&space;(&space;\frac{d}{r}&space;\right&space;)&space;=&space;haversin\left&space;(&space;\phi&space;_{2}&space;-&space;\phi&space;_{1}&space;\right&space;)&space;&plus;&space;cos\left&space;(&space;\phi&space;_{1}&space;\right&space;)cos\left&space;(&space;\phi&space;_{2}&space;\right&space;)haversin\left&space;(&space;\lambda&space;_{2}&space;-&space;\lambda&space;_{1}&space;\right&space;)" title="haversine\left ( \frac{d}{r} \right ) = haversin\left ( \phi _{2} - \phi _{1} \right ) + cos\left ( \phi _{1} \right )cos\left ( \phi _{2} \right )haversin\left ( \lambda _{2} - \lambda _{1} \right )" /></a>
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'haversine_fast'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install haversine_fast
+
+## Usage
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/haversine_fast/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'pry'
+require 'rake/extensiontask'
+
+
+Rake::ExtensionTask.new('calc_haversine')

data/ext/calc_haversine/calc_haversine.c

@@ -0,0 +1,41 @@
+#include <ruby.h>
+#include <math.h>
+
+void Init_calc_haversine();
+
+//define the following constants
+//radius of the earth, POLAR
+static const double RADIUS_OF_EARTH = 6335.592;
+
+//deg2rad
+static const double DEG2RAD = M_PI / 180;
+
+
+
+//ruby wants to call 
+//calculate_distance_by_haversine(lon1, lat1, lon2, lat2)
+
+#define NUM2RADDBL(x) (NUM2DBL(x) * DEG2RAD)
+
+static VALUE calculate_distance_by_haversine(VALUE self, VALUE lat1, VALUE lon1, VALUE lat2, VALUE lon2){
+  
+  double  dLat1 = NUM2RADDBL(lat1),
+          dLon1 = NUM2RADDBL(lon1),
+          dLat2 = NUM2RADDBL(lat2),
+          dLon2 = NUM2RADDBL(lon2),
+          result;
+
+  result = 2.0 * RADIUS_OF_EARTH *
+  asin(sqrt(
+    (1-cos(dLat2-dLat1))/2 + 
+    cos(dLat1)*cos(dLat2) * (1-cos(dLon2-dLon1))/2
+    ));
+
+  return rb_float_new(result);
+}
+
+void Init_calc_haversine(){
+  VALUE mHaversine = rb_define_module("HaversineFast");
+  rb_define_singleton_method(mHaversine, "calculate_distance_by_haversine", calculate_distance_by_haversine, 4);
+}
+

data/ext/calc_haversine/extconf.rb

@@ -0,0 +1,2 @@
+require "mkmf"
+create_makefile('calc_haversine')

data/haversine_fast.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'haversine_fast/version'
+
+gem_spec = Gem::Specification.new do |spec|
+  spec.name          = "haversine_fast"
+  spec.version       = HaversineFast::VERSION 
+  spec.authors       = ["Shaun Hubbard", "John F. Hogarty"]
+  spec.email         = ["shaunhubbard2013@icloud.com", "hogihung@gmail.com"]
+  spec.summary       = %q{A reasonable way to calculate the distance between two geographic locations given longitude and latitude for each.}
+  spec.description   = %q{ This calculates distance between two parts of the earth via Haversine formula at the speed of C}
+  spec.homepage      = "https://github.com/pedantix/haversine_fast"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "rspec", "~> 3.00"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-awesome_print"
+
+
+  #for C extension
+  spec.add_development_dependency "rake-compiler"
+
+  spec.extensions = "ext/calc_haversine/extconf.rb"
+
+end
+

data/lib/haversine_fast.rb

@@ -0,0 +1,9 @@
+require "haversine_fast/version"
+require "calc_haversine"
+
+module HaversineFast
+  module_function
+  def calc_distance(lat1, lon1, lat2, lon2)
+    calculate_distance_by_haversine(lat1, lon1, lat2, lon2)
+  end
+end

data/lib/haversine_fast/version.rb

@@ -0,0 +1,3 @@
+module HaversineFast
+  VERSION = "0.0.2"
+end

data/spec/haversine_distance_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+
+class TestLocation
+  attr_reader :longitude, :latitude, :description
+
+  def initialize(lat, lon, desc)
+    @longitude, @latitude, @description = lon, lat, desc
+  end
+end
+
+
+RSpec.describe HaversineFast do
+
+  let(:jax_residence) { TestLocation.new(30.199647, -81.524879, "Jacksonville Residence") }
+  let(:altamonte_springs_residence) { TestLocation.new(28.653973, -81.406500, "Altamonte Springs Residence")}
+  let(:jax_residence_2) { TestLocation.new(30.213115,-81.5738050, "Jacksonville Residence 2" ) }
+
+  let(:hong_kong_residence) { TestLocation.new(22.396428, 114.109497, "Hong Kong") }
+
+  let(:tolerance) { 1.00 }
+
+  it { expect(subject).to respond_to(:calc_distance) }
+
+  describe "should result in reasonably accurate distance calculations" do
+    #smoke test
+    def distance_between(loc1, loc2)
+      HaversineFast.calc_distance(loc1.latitude, loc1.longitude, loc2.latitude, loc2.longitude)
+    end
+
+    it { expect(HaversineFast.calc_distance(0.00,0.00,0.00,0.00)).to eql 0.00 }
+
+
+    it "should indicate there are 4.94 km between the two jax residence" do
+      expect(distance_between(jax_residence, jax_residence_2)).to be_within(tolerance).of(4.94)
+    end
+
+
+    it "should indicate there are 171.71 km between the two jax residence" do
+      expect(distance_between(jax_residence, altamonte_springs_residence)).to be_within(tolerance).of(171.71)
+    end
+
+    it "should indicate there are 13950.72km between jax residence and hong kong residence" do
+      expect(distance_between(jax_residence, hong_kong_residence)).to be_within(tolerance * 100).of(13950.72)
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "simplecov"
+
+require "haversine_fast"
+
+SimpleCov.start do
+  add_group "lib", 'lib/*'
+end
+
+
+RSpec.configure do |c|
+  c.before(:all) do
+    system "rake clean compile"
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: haversine_fast
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Shaun Hubbard
+- John F. Hogarty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.00'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.00'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " This calculates distance between two parts of the earth via Haversine
+  formula at the speed of C"
+email:
+- shaunhubbard2013@icloud.com
+- hogihung@gmail.com
+executables: []
+extensions:
+- ext/calc_haversine/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/calc_haversine/calc_haversine.c
+- ext/calc_haversine/extconf.rb
+- haversine_fast.gemspec
+- lib/haversine_fast.rb
+- lib/haversine_fast/version.rb
+- spec/haversine_distance_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pedantix/haversine_fast
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A reasonable way to calculate the distance between two geographic locations
+  given longitude and latitude for each.
+test_files:
+- spec/haversine_distance_spec.rb
+- spec/spec_helper.rb