fast_haversine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b07e617d5658471c451bf76a4159b4298ccafc0d
+  data.tar.gz: a4edd395979df2f93ee0e012ae111a3cc4541a7a
+SHA512:
+  metadata.gz: d56650f34068657a82473fcbde138273fb4ac46393f9ff50c4f547ec6a8276d3150b56738c2c4c2b58515a2ebca6b1a857b66f51771490c362d56241c80ec42a
+  data.tar.gz: 13f021381630c56c4e2a5aaa098fc2fff30f09acb30c848c96aeba613b0a6e9f42e8fb15a3c50ace2437e81dfcd2f06972f6bdc07f47e597d1598e363e77677d

data/.gitignore

@@ -0,0 +1,22 @@
+*.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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - rbx-2.2.10

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Paul Sorensen
+
+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,66 @@
+# FastHaversine
+[![Build Status](https://travis-ci.org/paulnsorensen/fast_haversine.svg?branch=master)](https://travis-ci.org/paulnsorensen/fast_haversine)
+[![Code Climate](https://codeclimate.com/github/paulnsorensen/fast_haversine/badges/gpa.svg)](https://codeclimate.com/github/paulnsorensen/fast_haversine)
+
+Haversine calculation written in Ruby that supports
+distances calculations in both miles and kilometers
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fast_haversine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fast_haversine
+
+## Usage
+
+For kilometers:
+
+```ruby
+distance = FastHaversine.distance_between([lat1, lon1], [lat2, lon2], :km)
+```
+
+For miles:
+
+```ruby
+distance = FastHaversine.distance_between([lat1, lon1], [lat2, lon2], :mi)
+```
+
+## Benchmark
+
+During specs, I ran the following benchmark:
+
+```ruby
+1_000_000.times { FastHaversine.distance_between(sf, chi, :mi) }
+
+0.700000   0.000000   0.700000 (  0.700143)
+```
+
+This is much faster than a common ruby implementation:
+
+```ruby
+1_000_000.times do
+  RubyHaversine.distance_between(
+    [37.7833, -122.4167],
+    [41.8819, -87.6278],
+    units: :mi
+  )
+end
+
+7.510000   0.320000   7.830000 (  7.930863)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/paulnsorensen/fast_haversine/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,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rake/extensiontask'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+Rake::ExtensionTask.new('fast_haversine') do |ext|
+  ext.lib_dir = 'lib/fast_haversine'
+end
+
+Rake::Task[:spec].prerequisites << :compile

data/ext/fast_haversine/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+
+create_makefile 'fast_haversine/fast_haversine'

data/ext/fast_haversine/fast_haversine.c

@@ -0,0 +1,56 @@
+// Copyright 2014 Paul Sorensen <paulnsorensen@gmail.com>
+
+#include <ruby.h>
+#include <math.h>
+
+static const double EARTH_RADIUS_IN_KM = 6371.0;
+static const double EARTH_RADIUS_IN_MI = 3958.755864232;
+static const double RADIAN_PER_DEGREE = M_PI / 180.0;
+
+static double haversine_c(
+      double lat1,
+      double lon1,
+      double lat2,
+      double lon2) {
+  double lon_delta = (lon2 - lon1) * RADIAN_PER_DEGREE;
+  double lat_delta = (lat2 - lat1) * RADIAN_PER_DEGREE;
+  double lat1_rad = lat1 * RADIAN_PER_DEGREE;
+  double lat2_rad = lat2 * RADIAN_PER_DEGREE;
+  double a = pow(sin(lat_delta * 0.5), 2) +
+      cos(lat1_rad) * cos(lat2_rad) * pow(sin(lon_delta * 0.5), 2);
+  return 2.0 * atan2(sqrt(a), sqrt(1 - a));
+}
+
+static VALUE rb_distance_in_mi(
+      VALUE self,
+      VALUE lat1,
+      VALUE lon1,
+      VALUE lat2,
+      VALUE lon2) {
+  double c = haversine_c(
+      NUM2DBL(lat1),
+      NUM2DBL(lon1),
+      NUM2DBL(lat2),
+      NUM2DBL(lon2));
+  return rb_float_new(c * EARTH_RADIUS_IN_MI);
+}
+
+static VALUE rb_distance_in_km(
+      VALUE self,
+      VALUE lat1,
+      VALUE lon1,
+      VALUE lat2,
+      VALUE lon2) {
+  double c = haversine_c(
+      NUM2DBL(lat1),
+      NUM2DBL(lon1),
+      NUM2DBL(lat2),
+      NUM2DBL(lon2));
+  return rb_float_new(c * EARTH_RADIUS_IN_KM);
+}
+
+void Init_fast_haversine() {
+  VALUE module = rb_define_module("FastHaversine");
+  rb_define_singleton_method(module, "distance_in_mi", rb_distance_in_mi, 4);
+  rb_define_singleton_method(module, "distance_in_km", rb_distance_in_km, 4);
+}

data/fast_haversine.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fast_haversine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fast_haversine'
+  spec.version       = FastHaversine::VERSION
+  spec.authors       = ['Paul Sorensen']
+  spec.email         = ['paulnsorensen@gmail.com']
+  spec.summary       = 'Ruby Haversine Calculation with C extension'
+  spec.description   = 'Haversine calculation written in Ruby that supports both
+                       distances in miles and kilometers'
+  spec.homepage      = 'https://github.com/paulnsorensen/fast_haversine'
+  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.extensions = ['ext/fast_haversine/extconf.rb']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake-compiler'
+end

data/lib/fast_haversine.rb

@@ -0,0 +1,13 @@
+require 'fast_haversine/version'
+require 'fast_haversine/fast_haversine'
+
+module FastHaversine
+  def self.distance_between(point_a, point_b, units)
+    case units
+    when :km
+      return distance_in_km(point_a[0], point_a[1], point_b[0], point_b[1])
+    when :mi
+      return distance_in_mi(point_a[0], point_a[1], point_b[0], point_b[1])
+    end
+  end
+end

data/lib/fast_haversine/version.rb

@@ -0,0 +1,3 @@
+module FastHaversine
+  VERSION = '0.0.1'
+end

data/spec/fast_haversine_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'lib/fast_haversine'
+
+describe FastHaversine do
+  describe '.distance_between' do
+    let(:sf) { [37.7833, -122.4167] }
+    let(:chi) { [41.8819, -87.6278] }
+
+    it 'calculates distance in miles' do
+      distance = FastHaversine.distance_between(sf, chi, :mi)
+
+      expect(distance.round(12)).to eql(1854.489697974166)
+    end
+
+    it 'calculates distance in kilometers' do
+      distance = FastHaversine.distance_between(sf, chi, :km)
+
+      expect(distance.round(12)).to eql(2984.511869636476)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH << File.expand_path('../..', __FILE__)
+
+require 'pry'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.color = true
+  config.tty = true
+  config.formatter = :documentation
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: fast_haversine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Sorensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-26 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: '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: 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: |-
+  Haversine calculation written in Ruby that supports both
+                         distances in miles and kilometers
+email:
+- paulnsorensen@gmail.com
+executables: []
+extensions:
+- ext/fast_haversine/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/fast_haversine/extconf.rb
+- ext/fast_haversine/fast_haversine.c
+- fast_haversine.gemspec
+- lib/fast_haversine.rb
+- lib/fast_haversine/version.rb
+- spec/fast_haversine_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/paulnsorensen/fast_haversine
+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: Ruby Haversine Calculation with C extension
+test_files:
+- spec/fast_haversine_spec.rb
+- spec/spec_helper.rb