geo_vectors 0.5.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color --format nested

data/Distance calc notes.txt

@@ -0,0 +1,64 @@
+Because of the near-spherical shape of the Earth (technically an oblate spheroid) , calculating an accurate distance between two points requires the use of spherical geometry and trigonometric math functions. However, you can calculate an approximate distance using much simpler math functions. For many applications the approximate distance calculation provides sufficient accuracy with much less complexity.
+
+The following approximate distance calculations are relatively simple, but can produce distance errors of 10 percent of more. These approximate calculations are performed using latitude and longitude values in degrees. The first approximation requires only simple math functions:
+
+Approximate distance in miles:
+
+    sqrt(x * x + y * y)
+
+where x = 69.1 * (lat2 - lat1)
+and y = 53.0 * (lon2 - lon1)
+
+You can improve the accuracy of this approximate distance calculation by adding the cosine math function:
+
+Improved approximate distance in miles:
+
+    sqrt(x * x + y * y)
+
+where x = 69.1 * (lat2 - lat1)
+and y = 69.1 * (lon2 - lon1) * cos(lat1/57.3)
+
+If you need greater accuracy, you can use the Great Circle Distance Formula. This formula requires use of spherical geometry and a high level of floating point mathematical accuracy - about 15 digits of accuracy (sometimes called "double-precision"). In order to use this formula properly make sure your software application or programming language is capable of double-precision floating point calculations. In addition, the trig math functions used in this formula require conversion of the latitude and longitude values from decimal degrees to radians. To convert latitude or longitude from decimal degrees to radians, divide the latitude and longitude values in this database by 180/pi, or approximately 57.29577951. The radius of the Earth is assumed to be 6,378.8 kilometers, or 3,963.0 miles.
+
+If you convert all latitude and longitude values in the database to radians before the calculation, use this equation:
+
+Great Circle Distance Formula using radians:
+
+    3963.0 * arccos[sin(lat1) *  sin(lat2) + cos(lat1) * cos(lat2) * cos(lon2 - lon1)]
+
+If you do NOT first convert the latitude and longitude values in the database to radians, you must include the degrees-to-radians conversion in the calculation. Substituting degrees for radians, the formula becomes:
+
+Great Circle Distance Formula using decimal degrees:
+
+    3963.0 * arccos[sin(lat1/57.2958) * sin(lat2/57.2958) + cos(lat1/57.2958) * cos(lat2/57.2958) *  cos(lon2/57.2958 -lon1/57.2958)]
+
+OR
+
+    r * acos[sin(lat1) * sin(lat2) + cos(lat1) * cos(lat2) * cos(lon2 - lon1)]
+
+Where r is the radius of the earth in whatever units you desire.
+r=3437.74677 (nautical miles)
+r=6378.7 (kilometers)
+r=3963.0 (statute miles)
+
+If the software application or programming language you are using has no arccosine function, you can calculate the same result using the arctangent function, which most applications and languages do support. Use the following equation:
+
+    3963.0 * arctan[sqrt(1-x^2)/x]
+
+where
+
+    x = [sin(lat1/57.2958) * sin(lat2/57.2958)] + [cos(lat1/57.2958) * cos(lat2/57.2958) * cos(lon2/57.2958 - lon1/57.2958)]
+
+If your distance calculations produce wildly incorrect results, check for these possible problems:
+
+1. Did you convert the latitude and longitude values from degrees to radians? Trigonometric math functions such as sine and cosine normally require conversion of degrees to radians, as described above.
+
+2. Are the equations implemented correctly with necessary parentheses? Remember the old math precedence rule: MDAS - multiply, divide, add, subtract.
+
+3. Does your software application or programming language provide sufficient mathematical accuracy? For best results, you need about 15 digits of accuracy. 
+
+4. When you imported the data from the text files your latitude/longitude values may have been truncated. Make sure you did not lose any of the digits to the right of the decimal point during import.
+
+5. Have you lost any precision of your decimal values due to rounding during importing or calling custom math functions?
+
+ 

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'geo_calc',     '>= 0.5.4'
+gem 'proxy_party',  '>= 0.2.1'
+gem 'sugar-high',   '>= 0.4.1'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec",    ">= 2.3.0"
+  gem "bundler",  ">= 1.0.0"
+  gem "jeweler",  ">= 1.6.0"
+  gem "rcov",     ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kristian Mandrup
+
+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.textile

@@ -0,0 +1,178 @@
+h1. Geo Vectors
+
+Vector classes and operations for Geo calculations.
+
+h2. Install
+
+@require 'geo_vectors_@
+
+h3. Gemfile
+
+Insert into Gemfile of the app:
+
+@gem 'geo_vectors'@
+
+Then run bundler from command line to bundle the gem with the app:
+
+@$ bundle@
+
+h2. Intro
+
+A GeoVector can be any of:
+
+1) *bearing vector* - bearing (direction in degrees) and a distance
+2) *direction vector* - direction (:N, :NW, :NE, :S, :SE, :SW, :E, :W) and a distance
+3) *point vector* - number of degrees due east/west (+ or -) and a distance due north/south (+ or -)
+
+Note that a direction vector is always converted to a bearing vector when added to a point
+
+A GeoVector can be applied to a GeoPoint (see geo_calc) or to another GeoVector.
+When multiple vectors are added together, the sum becomes a GeoVectors object.
+If a GeoVectors object is applied, the vectors are simply applied in turn.
+
+h2. Quick start (Usage guide)
+
+The following gives a quick overview for how to use the GeoVector API.
+
+_Note: This is suggested functionality._
+
+I plan to use my recently published _geo_calc_ gem as the base for the functionality described here.
+I need a major cleanup up of the current code...
+
+h3. Addition
+
+Vectors can be added to form a new Vector, using the simple formula vec = v1 + v2 = (v1.x + v2.y, v1.x + v2.y)
+
+h3. Vector on Vector addition
+
+If both vectors are point vectors, the result is simply a new point vector
+
+<pre>
+  v1 = [1, 3].vector
+  v2 = [-2, 2].vector
+  vec = v1 + v2
+  vec.unit.should == :degrees
+  vec.lat.should == -1
+  vec.lng.should == 5
+
+  # alternative addition operators
+  vec = v1 << v2  
+</pre>  
+
+h3. Vector subtraction
+
+<pre>
+  v1 = [1, 3].vector
+  v2 = [2, 1].vector
+  vec = v1 - v2 # here v2 inversed (scaled by -1) and then added 
+  vec.lat.should == -1
+  vec.lng.should == 2
+</pre>
+
+h3. Vector scaling
+
+<pre>
+  v1 = [1, 3].vector
+  vec = v1 * 2
+  vec.lat.should == 2
+  vec.lng.should == 6
+</pre>
+
+Scale a bearing vector
+
+<pre>
+  v1 = [32, 3.km].vector
+  vec = v1 * 2
+  vec.bearing.should == 32
+  vec.distance.should == 6.km
+</pre>
+
+
+Using division operator / for inverse scaling
+
+<pre>
+  v1 = [4, 2].vector
+  vec = v1 / 2
+  vec.lat.should == 2
+  vec.lng.should == 1
+</pre>
+
+h3. GeoVectors 
+
+Adding a point Vector to a bearing Vector
+
+If the vectors are of different type, a GeoVectors object is created 
+containing both vectors. A GeoVectors is a composite vector.
+
+<pre>
+  p1 = [1, -1]
+
+  v1 = [1, 3].vector # point Vector
+
+  # 32 deg bearing, 2.km
+  v2 = [32, 2.km].vector # bearing Vector
+  v2.bearing.should == 32
+  v2.distance.should == 2.km
+
+  vec = v1 + v2 # create a GeoVectors object
+  vec.should be_a(GeoVectors)
+  vec.vectors.size.should == 2 # should contain 2 vectors
+
+  # Adding more vectors to the GeoVectors object
+  vec.vectors << v3
+  vec << v4
+  
+  p2 = p1 + vec # Add GeoVectors to the point
+</pre>
+
+h3. Vector on Point addition
+
+Add a point Vector to a GeoPoint
+
+<pre>
+  p1 = [1, 3].geo_point
+  vec = [-2, 2].vector
+  p2 = p1 + vec
+  p2.lat.should == -1
+  p2.lng.should == 5  
+</pre>
+
+Add an inverse point Vector (subtract) to a GeoPoint
+
+<pre>
+  p1 = [1, 3].geo_point
+  vec = [2, 1].vector
+  p2 = p1 - vec
+  p2.lat.should == -1
+  p2.lng.should == 2
+</pre>
+
+Add a bearing Vector to a GeoPoint
+
+<pre>
+  p1 = [1, 3].geo_point
+
+  # 32 deg bearing, 2.km
+  vec = [32, 2.km].vector 
+
+  # use #destination_point from 'geo_calc' project
+  p2 = p1 + vec
+</pre>
+
+Note: You can also subtract (add with inverse bearing direction)
+
+h2. Contributing to geo_vectors
+ 
+* 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.
+
+h2. Copyright
+
+Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "geo_vectors"
+  gem.homepage = "http://github.com/kristianmandrup/geo_vectors"
+  gem.license = "MIT"
+  gem.summary = %Q{Geo vector library for applying vectors to GeoPoints and for basic vector math}
+  gem.description = %Q{Works with geo_calc and other geo libraries}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+
+  gem.add_runtime_dependency      'proxy_party',  '>= 0.2.1'
+  gem.add_runtime_dependency      'sugar-high',   '>= 0.4.1'
+  gem.add_runtime_dependency      'geo_calc',     '>= 0.5.4'
+  gem.add_development_dependency  'rspec',        '>= 2.5.0'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "geo_vectors #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/geo_vectors.gemspec

@@ -0,0 +1,115 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{geo_vectors}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Kristian Mandrup}]
+  s.date = %q{2011-05-23}
+  s.description = %q{Works with geo_calc and other geo libraries}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.textile"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Distance calc notes.txt",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "geo_vectors.gemspec",
+    "lib/geo_vectors.rb",
+    "lib/geo_vectors/bearing_vector.rb",
+    "lib/geo_vectors/core_ext.rb",
+    "lib/geo_vectors/direction_vector.rb",
+    "lib/geo_vectors/geo_point.rb",
+    "lib/geo_vectors/geo_vector.rb",
+    "lib/geo_vectors/geo_vectors.rb",
+    "lib/geo_vectors/point_vector.rb",
+    "lib/geo_vectors/point_vector/point_ops.rb",
+    "lib/geo_vectors/point_vector/vector_ops.rb",
+    "lib/geo_vectors/util.rb",
+    "lib/geo_vectors/util/calc.rb",
+    "lib/geo_vectors/util/geo_direction.rb",
+    "lib/geo_vectors/util/geo_distance.rb",
+    "lib/geo_vectors/util/geo_units.rb",
+    "lib/geo_vectors/vector_parser.rb",
+    "spec/geo_vectors/API proposal guide.txt",
+    "spec/geo_vectors/bearing_vector/add_vector_spec.rb",
+    "spec/geo_vectors/bearing_vector/random_spec.rb",
+    "spec/geo_vectors/bearing_vector_spec.rb",
+    "spec/geo_vectors/direction_vector/add_vector_spec.rb",
+    "spec/geo_vectors/direction_vector/point_add_spec.rb",
+    "spec/geo_vectors/direction_vector/random_spec.rb",
+    "spec/geo_vectors/direction_vector/subtract_vector_spec.rb",
+    "spec/geo_vectors/direction_vector_spec.rb",
+    "spec/geo_vectors/geo_vectors_spec.rb",
+    "spec/geo_vectors/point_vector/add_vector_spec.rb",
+    "spec/geo_vectors/point_vector/initializer_spec.rb",
+    "spec/geo_vectors/point_vector/point_add_spec.rb",
+    "spec/geo_vectors/point_vector/random_spec.rb",
+    "spec/geo_vectors/point_vector/scale_vector_spec.rb",
+    "spec/geo_vectors/point_vector/subtract_vector_spec.rb",
+    "spec/geo_vectors/point_vector_spec.rb",
+    "spec/geo_vectors/util/geo_direction_spec.rb",
+    "spec/geo_vectors/util/geo_distance_spec.rb",
+    "spec/geo_vectors/util/geo_units_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/geo_vectors}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.0}
+  s.summary = %q{Geo vector library for applying vectors to GeoPoints and for basic vector math}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<geo_calc>, [">= 0.5.4"])
+      s.add_runtime_dependency(%q<proxy_party>, [">= 0.2.1"])
+      s.add_runtime_dependency(%q<sugar-high>, [">= 0.4.1"])
+      s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<proxy_party>, [">= 0.2.1"])
+      s.add_runtime_dependency(%q<sugar-high>, [">= 0.4.1"])
+      s.add_runtime_dependency(%q<geo_calc>, [">= 0.5.4"])
+      s.add_development_dependency(%q<rspec>, [">= 2.5.0"])
+    else
+      s.add_dependency(%q<geo_calc>, [">= 0.5.4"])
+      s.add_dependency(%q<proxy_party>, [">= 0.2.1"])
+      s.add_dependency(%q<sugar-high>, [">= 0.4.1"])
+      s.add_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<proxy_party>, [">= 0.2.1"])
+      s.add_dependency(%q<sugar-high>, [">= 0.4.1"])
+      s.add_dependency(%q<geo_calc>, [">= 0.5.4"])
+      s.add_dependency(%q<rspec>, [">= 2.5.0"])
+    end
+  else
+    s.add_dependency(%q<geo_calc>, [">= 0.5.4"])
+    s.add_dependency(%q<proxy_party>, [">= 0.2.1"])
+    s.add_dependency(%q<sugar-high>, [">= 0.4.1"])
+    s.add_dependency(%q<rspec>, [">= 2.3.0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<proxy_party>, [">= 0.2.1"])
+    s.add_dependency(%q<sugar-high>, [">= 0.4.1"])
+    s.add_dependency(%q<geo_calc>, [">= 0.5.4"])
+    s.add_dependency(%q<rspec>, [">= 2.5.0"])
+  end
+end
+