geo_vectors 0.5.0

data/lib/geo_vectors/point_vector/point_ops.rb

@@ -0,0 +1,23 @@
+class PointVector < GeoVector
+  module PointOps
+    # return new point from adding vector to point
+    def add_to_point point
+      add_to_point! point.dup
+    end
+
+    # add vector directly to point (destructive update)
+    def add_to_point! point
+      point.lat = lat + point.lat 
+      point.lng = lng + point.lng
+      point
+    end
+
+    def sub_from_point point
+      reverse.add_to_point point    
+    end
+
+    def sub_from_point! point
+      reverse.add_to_point! point
+    end
+  end
+end

data/lib/geo_vectors/point_vector/vector_ops.rb

@@ -0,0 +1,38 @@
+class PointVector < GeoVector
+  module VectorOps
+    def random_vector                             
+      lat_max = point.lat.abs
+      lng_max = point.lng.abs    
+      rand_lat = rand(lat_max * 2) - lat_max
+      rand_lng = rand(lng_max * 2) - lng_max
+      PointVector.new [rand_lat, rand_lng]
+    end
+
+    def add *args
+      self.dup.add! *args 
+    end
+    alias_method :<<, :add
+    alias_method :+,  :add
+
+    def add! *args
+      vector = GeoVector::Parser.create_vector *args
+      case vector
+      when PointVector
+        v2 = add_to_point vector
+        self.point = v2.to_arr
+        self      
+      else
+        GeoVectors.new self, vector
+      end
+    end
+
+    def sub *args
+      self.dup.sub! *args
+    end
+
+    def sub! *args
+      vector = GeoVector::Parser.create_vector *args
+      add! vector.reverse
+    end
+  end
+end

data/lib/geo_vectors/util.rb

@@ -0,0 +1,3 @@
+require 'geo_vectors/util/geo_direction'
+require 'geo_vectors/util/geo_distance'
+require 'geo_vectors/util/geo_units'

data/lib/geo_vectors/util/calc.rb

@@ -0,0 +1,89 @@
+module Calc
+  protected
+
+  def earth_radius_radians
+    2 * Math::PI
+  end
+
+  def bounding_box(point, radius, options = {})
+    lat,lon = extract_coordinates(point)
+    radius  = radius.to_f
+    units   = options[:units] || :mi
+    [
+      lat - (radius / latitude_degree_distance(units)),
+      lon - (radius / longitude_degree_distance(lat, units)),
+      lat + (radius / latitude_degree_distance(units)),
+      lon + (radius / longitude_degree_distance(lat, units))
+    ]
+  end
+
+  def calc_point vector, mode
+    vector = relative_vector(vector) if mode == :relative
+    GeoPoint.new lat + vector.lat, lng + vector.lng        
+  end 
+
+  def relative_vector vector
+    delta_lng = vector.lng / longitude_radian_distance(lat)
+    delta_lat = vector.lat / latitude_radian_distance
+    Vector.new delta_lat, delta_lng
+  end
+
+  def degrees_to_radians degrees
+    degrees / 57.29578
+  end
+
+  def delta_lat degrees, distance
+    rad = degrees_to_radians(degrees)
+    Math.sin(rad) * distance
+  end
+
+  def delta_lng degrees, distance
+    rad = degrees_to_radians(degrees)
+    Math.cos(rad) * distance
+  end
+
+  def latitude_radian_distance
+    0.017453292519943295
+  end
+
+  def longitude_radian_distance(latitude)
+    latitude_radian_distance * Math.cos(latitude)
+  end
+
+  def distance_to_radians(distance, units = :mi)
+    distance.to_f / earth_radius(units)
+  end
+
+  def radians_to_distance(radians, units = :mi)
+    radians * earth_radius(units)
+  end
+
+  ##
+  # Distance spanned by one degree of latitude in the given units.
+  #
+  def latitude_degree_distance(units = :mi)
+    2 * Math::PI * earth_radius(units) / 360
+  end
+
+  ##
+  # Convert kilometers to miles.
+  #
+  def to_miles(km)
+    km * km_in_mi
+  end
+
+  ##
+  # Radius of the Earth in the given units (:mi or :km). Default is :mi.
+  #
+  def earth_radius(units = :mi)
+    units == :km ? EARTH_RADIUS : to_miles(EARTH_RADIUS)
+  end
+
+  ##
+  # Distance spanned by one degree of longitude at the given latitude.
+  # This ranges from around 69 miles at the equator to zero at the poles.
+  #
+  def longitude_degree_distance(latitude, units = :mi)
+    latitude_degree_distance(units) * Math.cos(to_radians(latitude))
+  end      
+end

data/lib/geo_vectors/util/geo_direction.rb

@@ -0,0 +1,101 @@
+module GeoDirection
+  def valid_directions
+    [:north, :south, :east, :west, :N, :S, :E, :W, :NW, :NE, :SW, :SE]
+  end
+
+  def directions
+    [:N, :S, :E, :W, :NW, :NE, :SW, :SE]
+  end
+
+  def random_direction
+    directions[rand(directions.size)]
+  end
+  
+  def valid_direction? dir
+    valid_directions.include? dir
+  end
+
+  def dir_to_bearing dir
+    dir = dir_to_bearing_map[dir]
+    raise "No bearing for direction #{dir} could be found" if !dir
+    dir
+  end
+
+  def bearing_to_dir brng
+    dir = bearing_to_dir_map[:"_#{brng}"]
+    raise "No direction could be for the bearing #{brng}" if !dir
+    dir
+  end
+
+  def get_valid_direction dir
+    return dir_map[dir] if dir_map[dir]
+    raise "Not a valid direction: #{dir}" if !directions.include? dir
+    dir
+  end  
+
+  def to_bearing_vector direction, distance
+    distance, direction = [direction, distance] if direction.kind_of?(GeoDistance) || distance.kind_of?(Symbol)
+    BearingVector.new distance, dir_to_bearing(direction)
+  end
+
+  def to_point_vector direction, distance
+    # dist degrees
+    dd = distance.to_deg
+    
+    lng, lat = case direction
+    when :N
+      [0, -dd]
+    when :S
+      [0, dd]
+    when :W
+      [-dd, 0]
+    when :E
+      [dd, 0]
+    when :NW
+      [dd, b]
+    when :SW
+      [dd, -dd]
+    when :NE
+      [-dd, dd]
+    when :SE
+      [-dd, -dd]
+    end
+    [lat, lng].vector
+  end
+
+  protected
+  
+  def check_direction! dir
+    raise ArgumentError, "Not a valid direction: #{dir}" if !valid_direction?
+  end   
+
+  def dir_map 
+    {:east => :E, :north => :N, :west => :W, :south => :S}
+  end
+  
+  def bearing_to_dir_map
+    {
+      :_0   => :N,    # East
+      :_45  => :NE,   # North East
+      :_90  => :N,    # North
+      :_135 => :NW,   # North West
+      :_180 => :W,    # West (2*90)
+      :_225 => :SW,   # South West
+      :_270 => :S,    # South (3*90)
+      :_315 => :SE    # South East
+    }
+  end  
+  
+  def dir_to_bearing_map
+    {
+      :E  => 0,     # East
+      :NE => 45,    # North East
+      :N  => 90,    # North
+      :NW => 135,   # North West
+      :W  => 180,   # West (2*90)
+      :SW => 225,   # South West
+      :S  => 270,   # South (3*90)
+      :SE => 315    # South East
+    }
+  end  
+end

data/lib/geo_vectors/util/geo_distance.rb

@@ -0,0 +1,135 @@
+require 'geo_vectors/util/geo_units'
+require 'active_support/inflector'
+
+class GeoDistance
+  include NumericCheckExt
+  include GeoUnits 
+  include Comparable
+  
+  attr_accessor :unit, :number
+  
+  def initialize number, unit = :kms
+    check_unit! unit
+    check_numeric! number 
+
+    @unit = unit
+    @number = number
+  end
+
+  def to_s
+    "distance: #{number} #{unit}"
+  end
+
+  def * factor  
+    dist = self.dup
+    dist.number *= factor
+    dist
+  end
+
+  def / factor  
+    dist = self.dup
+    dist.number /= factor
+    dist
+  end
+
+  # compare 2 distances
+  def <=> dist
+    dist = extract_distance(dist).as(unit)
+    if number < dist.number
+      -1
+    elsif number > dist.number
+      1
+    else
+      0
+    end
+  end
+
+  def convert_to_meters
+    (unit == :radians) ? radians_to(:meters) : number / meters_map[unit]
+  end
+
+  # convert to unit (see GeoMagic)
+  def as unit
+    check_unit! unit
+    dist = self.dup
+    dist.number = convert_to_meters * meters_map[unit]
+    dist.unit = unit
+    dist    
+  end
+
+  # from GeoUnits    
+  GeoUnits.valid_units.map(&:to_s).each do |unit|
+    one_unit = unit.singularize
+    class_eval %{
+      def #{one_unit}
+        as(:#{unit}).number
+      end          
+
+      def as_#{unit}
+        as(:#{unit})
+      end          
+
+      alias_method :to_#{unit}, :#{one_unit}
+      alias_method :in_#{unit}, :#{one_unit}
+      alias_method :#{unit.pluralize}, :#{one_unit}
+    }
+  end   
+
+  def random
+    rand(number.to_f * 100) / 100.0
+  end
+
+  def radians_to unit
+    check_unit! unit
+    earth_radius[unit] * number
+  end
+
+  protected
+
+  include GeoUnits::UnitMaps
+
+  # converts a number into a distance of same unit  
+  def extract_distance dist
+    is_numeric?(dist) ? dist.send(unit) : dist  
+  end
+
+  # used to extend Fixnum and Float
+  module Unit
+    extend GeoUnits
+    extend GeoUnits::UnitMaps
+    
+    # from GeoUnits    
+    valid_units.map(&:to_s).each do |unit|
+      one_unit = unit.singularize
+      class_eval %{
+        def #{one_unit}
+          GeoDistance.new self, :#{unit}
+        end          
+        alias_method :to_#{unit}, :#{one_unit}
+        alias_method :in_#{unit}, :#{one_unit}
+        alias_method :as_#{unit}, :#{one_unit}
+        alias_method :#{unit.pluralize}, :#{one_unit}
+      }
+    end   
+    
+    def [] key
+      raise ArgumentError, "Invalid unit key #{key}" if !respond_to? key
+      earth_radius[key] * self
+    end    
+  end
+
+  module Extract
+    def extract_distance dist
+      case dist
+      when Fixnum, Float
+        dist.km
+      when GeoDistance
+        dist
+      else
+        raise ArgumentError, "Could not convert #{dist} to a GeoDistance"
+      end
+    end
+  end
+  
+  include Extract  
+end

data/lib/geo_vectors/util/geo_units.rb

@@ -0,0 +1,53 @@
+module GeoUnits
+  module Methods
+    def valid_units
+      [:feet, :meters, :kms, :miles, :radians]
+    end
+
+    def valid_unit? unit
+      valid_units.include? unit
+    end
+
+    # The default unit is assumed to be kms
+    # This can be changed
+    # Example:
+    #   GeoVector.default_unit = :km
+
+    def default_unit
+      @default_unit || :kms
+    end
+
+    def default_unit= unit
+      @default_unit || :kms
+    end
+
+    def check_unit! unit
+      raise ArgumentError, "Not a valid unit" if !valid_unit? unit
+    end   
+  end
+  
+  include Methods
+  extend Methods
+  
+  module UnitMaps
+
+    def earth_radius
+      {
+        :feet => 20895592, 
+        :meters => 6371000,
+        :kms => 6371, 
+        :miles => 3956
+      }
+    end
+
+    def meters_map
+      {
+       :feet => 3.2808,
+       :meters => 1,
+       :kms => 0.001,
+       :miles => 0.00062137,
+       :radians => 111170
+      }
+    end
+  end  
+end