rvincenty 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Reto Schüttel, <reto ät schuettel (DOT) ch>
+
+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.rdoc

@@ -0,0 +1,37 @@
+= rvincenty
+
+This is a ruby implementation of the Vincenty's formulae to calcuclate the distance between
+two points on earth. The formula assumpts that the figure of the Earth is an oblate spheroid
+and is therefore much accurate than other methods which assume a spherical Earth.
+
+The code was heavily inspired by Chris Veness Javascript implementation and explainaitions:
+
+
+[Vincenty formula for distance between two Latitude/Longitude points] http://www.movable-type.co.uk/scripts/latlong-vincenty.html
+
+== Usage
+
+    require 'rvincenty'
+
+    point_a = 45.965, 63.305    # Baikonur Cosmodrome
+    point_b = 28.585, -80.651   # John F. Kennedy Space Center
+
+    distance = RVincenty.distance(point_a, point_b)
+
+    puts "Distance between %s and %s is %f km" % [point_a.inspect, point_b.inspect, distance / 1000]
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Reto Schüttel. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/setup'
+
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rvincenty"
+    gem.summary = "Pure Ruby implementation of Vincenty formula to calculate distance between two points"
+    gem.description = "rvincenty is a pure ruby implementation of Thaddeus Vincenty's formulae "
+                      "which caluclates the distance between two points on the earth's surface"
+    gem.email = "reto@schuettel.ch"
+    gem.homepage = "http://github.com/retoo/rvincenty"
+    gem.authors = ["Reto Schüttel"]
+    gem.add_development_dependency "yard"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rvincenty.rb

@@ -0,0 +1,72 @@
+module RVincenty
+  # Calculates the distance between two given points.
+  # A point is a two-elmeent array containing the points coordinates (Latitude and Longitutde)
+  # experessed as a floating point number.
+  def self.distance(point_a, point_b)
+    lat1, lon1 = point_a
+    lat2, lon2 = point_b
+
+    # WGS-84 ellipsiod
+    a = 6378137.0
+    b = 6356752.3142
+    f = 1.0/298.257223563
+
+    l = deg_to_rad(lon2 - lon1)
+    u1 = Math.atan((1.0-f) * Math.tan(deg_to_rad(lat1)));
+    u2 = Math.atan((1.0-f) * Math.tan(deg_to_rad(lat2)));
+
+    sinU1 = Math.sin(u1)
+    cosU1 = Math.cos(u1)
+    sinU2 = Math.sin(u2)
+    cosU2 = Math.cos(u2)
+
+    lambda = l
+
+    iterLimit = 100
+    lambdaP = nil
+    while true
+      sinLambda = Math.sin(lambda)
+      cosLambda = Math.cos(lambda)
+
+      sinSigma = Math.sqrt((cosU2*sinLambda) * (cosU2*sinLambda) +
+        (cosU1*sinU2-sinU1*cosU2*cosLambda) * (cosU1*sinU2-sinU1*cosU2*cosLambda))
+
+      # co-incident points
+      return 0 if (sinSigma==0)
+
+      cosSigma = sinU1*sinU2 + cosU1*cosU2*cosLambda;
+      sigma = Math.atan2(sinSigma, cosSigma);
+      sinalpha = cosU1 * cosU2 * sinLambda / sinSigma;
+      cosSqalpha = 1.0 - sinalpha*sinalpha;
+      cos2SigmaM = cosSigma - 2.0*sinU1*sinU2/cosSqalpha;
+      if cos2SigmaM.nan?
+        cos2SigmaM = 0
+      end
+
+      c = f/16*cosSqalpha*(4+f*(4-3*cosSqalpha));
+      lambdaP = lambda;
+      lambda = l + (1.0-c) * f * sinalpha * (sigma + c*sinSigma*(cos2SigmaM+c*cosSigma*(-1+2*cos2SigmaM*cos2SigmaM)));
+      iterLimit -= 1
+
+      break if (lambda-lambdaP).abs < 1e-12 || iterLimit <= 0
+    end
+
+    #formula failed to converge
+    return NaN if (iterLimit==0)
+
+    uSq = cosSqalpha * (a*a - b*b) / (b*b);
+    va = 1 + uSq/16384.0*(4096.0+uSq*(-768.0+uSq*(320.0-175.0*uSq)))
+    vb = uSq/1024.0 * (256.0+uSq*(-128.0+uSq*(74.0-47.0*uSq)))
+    deltaSigma = vb*sinSigma*(cos2SigmaM+vb/4.0*(cosSigma*(-1.0+2.0*cos2SigmaM*cos2SigmaM)-
+      vb/6*cos2SigmaM*(-3.0+4.0*sinSigma*sinSigma)*(-3+4*cos2SigmaM*cos2SigmaM)))
+    s = b*va*(sigma-deltaSigma)
+
+    return s;
+  end
+
+  private
+
+  def self.deg_to_rad(deg)
+    (Math::PI * deg) / 180
+  end
+end

data/rvincenty.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rvincenty}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Reto Sch\303\274ttel"]
+  s.date = %q{2009-08-23}
+  s.description = %q{rvincenty is a pure ruby implementation of Thaddeus Vincenty's formulae }
+  s.email = %q{reto@schuettel.ch}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rvincenty.rb",
+     "rvincenty.gemspec",
+     "test/rvincenty_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/retoo/rvincenty}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Pure Ruby implementation of Vincenty formula to calculate distance between two points}
+  s.test_files = [
+    "test/rvincenty_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end

data/test/rvincenty_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+require 'rvincenty'
+
+
+class RVincentyTest < Test::Unit::TestCase
+  # positions are from Wikipedia
+  BAIKONUR_COSMODROME               = [45.965, 63.305         ]
+  KENNEDY_SPACE_CENTER              = [28.585, -80.651        ]
+  JIUQUAN_SATELLITE_LAUNCH_CENTER   = [40.957778, 100.291667  ]
+  SAN_MARCO_PLATFORM                = [-2.938333, 40.2125     ]
+  SOUTH_POLE                        = [-90, -0                ]
+  NORTH_POLE                        = [90, -0                 ]
+  AMUNDSEN_SCOTT_SOUTH_POLE_STATION = [-90, -139.266667       ]
+
+  # distance values are from http://www.movable-type.co.uk/scripts/latlong-vincenty.html
+  DISTANCES = [
+    [BAIKONUR_COSMODROME, KENNEDY_SPACE_CENTER, 10_986_163.684],
+    [SOUTH_POLE, JIUQUAN_SATELLITE_LAUNCH_CENTER, 14_537_850.120],
+    [SOUTH_POLE, AMUNDSEN_SCOTT_SOUTH_POLE_STATION, 0],
+    [SOUTH_POLE, NORTH_POLE, 20_003_931.459],
+    [NORTH_POLE, SOUTH_POLE, 20_003_931.459],
+    [BAIKONUR_COSMODROME, JIUQUAN_SATELLITE_LAUNCH_CENTER, 3_016_381.278],
+    [AMUNDSEN_SCOTT_SOUTH_POLE_STATION, SAN_MARCO_PLATFORM, 9_677_058.827],
+    [AMUNDSEN_SCOTT_SOUTH_POLE_STATION, AMUNDSEN_SCOTT_SOUTH_POLE_STATION, 0],
+    [JIUQUAN_SATELLITE_LAUNCH_CENTER, BAIKONUR_COSMODROME, 3016381.278],
+  ]
+
+  def test_vincenty
+    DISTANCES.each do |a, b, distance|
+      calc_distance = RVincenty.distance(a,b)
+
+      assert_in_delta distance, calc_distance, 0.0005, "from: %s to: %s" % [a.inspect, b.inspect]
+    end
+  end
+  
+  def test_readme_example
+    point_a = 45.965, 63.305    # Baikonur Cosmodrome
+    point_b = 28.585, -80.651   # John F. Kennedy Space Center
+    
+    distance = RVincenty.distance(point_a, point_b)
+    
+    assert_in_delta distance, 10_986_163.684, 0.0005
+    
+    out = "Distance between %s and %s is %f km" % [point_a.inspect, point_b.inspect, distance / 1000]
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rvincenty'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: rvincenty
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Reto Sch\xC3\xBCttel"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-27 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rake
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: yard
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: "rvincenty is a pure ruby implementation of Thaddeus Vincenty's formulae "
+email: reto@schuettel.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rvincenty.rb
+- rvincenty.gemspec
+- test/rvincenty_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/retoo/rvincenty
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Pure Ruby implementation of Vincenty formula to calculate distance between two points
+test_files: []
+