module Geocoder::Calculations

def bearing_between(point1, point2, options = {})


Based on: http://www.movable-type.co.uk/scripts/latlong.html

Use Geocoder.configure(:distances => ...) to configure calculation method.
(returns due east or west when given two points with the same latitude).
(one along a great circle) but the linear method is less confusing
the spherical method is "correct" in that it returns the shortest path
* :method - :linear or :spherical;

ways of specifying the points. Also accepts an options hash:
See Geocoder::Calculations.distance_between for

Returns a number of degrees from due north (clockwise).
Bearing between two points on Earth.
#
def bearing_between(point1, point2, options = {})
  # set default options
  options[:method] ||= Geocoder.config.distances
  options[:method] = :linear unless options[:method] == :spherical
  # convert to coordinate arrays
  point1 = extract_coordinates(point1)
  point2 = extract_coordinates(point2)
  # convert degrees to radians
  point1 = to_radians(point1)
  point2 = to_radians(point2)
  # compute deltas
  dlat = point2[0] - point1[0]
  dlon = point2[1] - point1[1]
  case options[:method]
  when :linear
    y = dlon
    x = dlat
  when :spherical
    y = Math.sin(dlon) * Math.cos(point2[0])
    x = Math.cos(point1[0]) * Math.sin(point2[0]) -
        Math.sin(point1[0]) * Math.cos(point2[0]) * Math.cos(dlon)
  end
  bearing = Math.atan2(x,y)
  # Answer is in radians counterclockwise from due east.
  # Convert to degrees clockwise from due north:
  (90 - to_degrees(bearing) + 360) % 360
end

def bounding_box(point, radius, options = {})


Use Geocoder.configure(:units => ...) to configure default units.
* :units - :mi or :km.

ways of specifying the point. Also accepts an options hash:
See Geocoder::Calculations.distance_between for

(ActiveRecord queries use it thusly).
roughly limiting the possible solutions in a geo-spatial search
This is useful for finding corner points of a map viewport, or for

is twice the radius).
from the center point to any side of the box (the length of each side
with the given point at its center. The radius is the shortest distance
Returns coordinates of the southwest and northeast corners of a box
#
def bounding_box(point, radius, options = {})
  lat,lon = extract_coordinates(point)
  radius  = radius.to_f
  units   = options[:units] || Geocoder.config.units
  [
    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 compass_point(bearing, points = COMPASS_POINTS)


Translate a bearing (float) into a compass direction (string, eg "North").
#
def compass_point(bearing, points = COMPASS_POINTS)
  seg_size = 360 / points.size
  points[((bearing + (seg_size / 2)) % 360) / seg_size]
end

def coordinates_present?(*args)


Returns true if all given arguments are valid latitude/longitude values.
#
def coordinates_present?(*args)
  args.each do |a|
    # note that Float::NAN != Float::NAN
    # still, this could probably be improved:
    return false if (!a.is_a?(Numeric) or a.to_s == "NaN")
  end
  true
end

def distance_between(point1, point2, options = {})


Use Geocoder.configure(:units => ...) to configure default units.
* :units - :mi or :km

The options hash supports:

which returns a [lat,lon] array
* a geocoded object (one which implements a +to_coordinates+ method
* a geocodable address (string)
* an array of coordinates ([lat,lon])

Geocoder methods that accept points as arguments. They can be:
The points are given in the same way that points are given to all
Takes two points and an options hash.
Distance between two points on Earth (Haversine formula).
#
def distance_between(point1, point2, options = {})
  # set default options
  options[:units] ||= Geocoder.config.units
  # convert to coordinate arrays
  point1 = extract_coordinates(point1)
  point2 = extract_coordinates(point2)
  # convert degrees to radians
  point1 = to_radians(point1)
  point2 = to_radians(point2)
  # compute deltas
  dlat = point2[0] - point1[0]
  dlon = point2[1] - point1[1]
  a = (Math.sin(dlat / 2))**2 + Math.cos(point1[0]) *
      (Math.sin(dlon / 2))**2 * Math.cos(point2[0])
  c = 2 * Math.atan2( Math.sqrt(a), Math.sqrt(1-a))
  c * earth_radius(options[:units])
end

def distance_to_radians(distance, units = nil)

def distance_to_radians(distance, units = nil)
  units ||= Geocoder.config.units
  distance.to_f / earth_radius(units)
end

def earth_radius(units = nil)


Use Geocoder.configure(:units => ...) to configure default units.
Radius of the Earth in the given units (:mi or :km).
#
def earth_radius(units = nil)
  units ||= Geocoder.config.units
  case units
    when :km; EARTH_RADIUS
    when :mi; to_miles(EARTH_RADIUS)
    when :nm; to_nautical_miles(EARTH_RADIUS)
  end
end

def endpoint(start, heading, distance, options = {})


which returns a [lat,lon] array
* a geocoded object (one which implements a +to_coordinates+ method
* a geocodable address (string)
* an array of coordinates ([lat,lon])

Geocoder methods that accept points as arguments. It can be:
The starting point is given in the same way that points are given to all
an endpoint.
Given a start point, distance, and heading (in degrees), provides
#
def endpoint(start, heading, distance, options = {})
  options[:units] ||= Geocoder.config.units
  radius = earth_radius(options[:units])
  start = extract_coordinates(start)
  # convert degrees to radians
  start = to_radians(start)
  lat = start[0]
  lon = start[1]
  heading = to_radians(heading)
  distance = distance.to_f
  end_lat = Math.asin(Math.sin(lat)*Math.cos(distance/radius) +
                Math.cos(lat)*Math.sin(distance/radius)*Math.cos(heading))
  end_lon = lon+Math.atan2(Math.sin(heading)*Math.sin(distance/radius)*Math.cos(lat),
                Math.cos(distance/radius)-Math.sin(lat)*Math.sin(end_lat))
  to_degrees [end_lat, end_lon]
end

def extract_coordinates(point)


running method and may return nil.
[lat,lon] array. Note that if a string is passed this may be a slow-
or an object that implements +to_coordinates+ and returns a
Takes an object which is a [lat,lon] array, a geocodable string,
#
def extract_coordinates(point)
  case point
  when Array
    if point.size == 2
      lat, lon = point
      if !lat.nil? && lat.respond_to?(:to_f) and
        !lon.nil? && lon.respond_to?(:to_f)
      then
        return [ lat.to_f, lon.to_f ]
      end
    end
  when String
    point = Geocoder.coordinates(point) and return point
  else
    if point.respond_to?(:to_coordinates)
      if Array === array = point.to_coordinates
        return extract_coordinates(array)
      end
    end
  end
  [ NAN, NAN ]
end

def geographic_center(points)


the procedure documented at http://www.geomidpoint.com/calculation.html.
(can be mixed). Any objects missing coordinates are ignored. Follows
gravity) for an array of geocoded objects and/or [lat,lon] arrays
Compute the geographic center (aka geographic midpoint, center of
#
def geographic_center(points)
  # convert objects to [lat,lon] arrays and convert degrees to radians
  coords = points.map{ |p| to_radians(extract_coordinates(p)) }
  # convert to Cartesian coordinates
  x = []; y = []; z = []
  coords.each do |p|
    x << Math.cos(p[0]) * Math.cos(p[1])
    y << Math.cos(p[0]) * Math.sin(p[1])
    z << Math.sin(p[0])
  end
  # compute average coordinate values
  xa, ya, za = [x,y,z].map do |c|
    c.inject(0){ |tot,i| tot += i } / c.size.to_f
  end
  # convert back to latitude/longitude
  lon = Math.atan2(ya, xa)
  hyp = Math.sqrt(xa**2 + ya**2)
  lat = Math.atan2(za, hyp)
  # return answer in degrees
  to_degrees [lat, lon]
end

def km_in_mi


Conversion factor: km to mi.
#
def km_in_mi
  KM_IN_MI
end

def km_in_nm


Conversion factor: km to nm.
#
def km_in_nm
  KM_IN_NM
end

def latitude_degree_distance(units = nil)


Distance spanned by one degree of latitude in the given units.
#
def latitude_degree_distance(units = nil)
  units ||= Geocoder.config.units
  2 * Math::PI * earth_radius(units) / 360
end

def longitude_degree_distance(latitude, units = nil)


This ranges from around 69 miles at the equator to zero at the poles.
Distance spanned by one degree of longitude at the given latitude.
#
def longitude_degree_distance(latitude, units = nil)
  units ||= Geocoder.config.units
  latitude_degree_distance(units) * Math.cos(to_radians(latitude))
end

def mi_in_km


Conversion factor: mi to km.
#
def mi_in_km
  1.0 / KM_IN_MI
end

def nm_in_km


Conversion factor: nm to km.
#
def nm_in_km
  1.0 / KM_IN_NM
end

def radians_to_distance(radians, units = nil)

def radians_to_distance(radians, units = nil)
  units ||= Geocoder.config.units
  radians * earth_radius(units)
end

def random_point_near(center, radius, options = {})

Use Geocoder.configure(:units => ...) to configure default units.
* :units - :mi or :km

The options hash supports:

which returns a [lat,lon] array
* a geocoded object (one which implements a +to_coordinates+ method
* a geocodable address (string)
* an array of coordinates ([lat,lon])

Geocoder methods that accept points as arguments. They can be:
The points are given in the same way that points are given to all
Takes one point, one radius, and an options hash.
around the provided point
Random point within a circle of provided radius centered
#
def random_point_near(center, radius, options = {})
  # set default options
  options[:units] ||= Geocoder.config.units
  # convert to coordinate arrays
  center = extract_coordinates(center)
  earth_circumference = 2 * Math::PI * earth_radius(options[:units])
  max_degree_delta =  360.0 * (radius / earth_circumference)
  # random bearing in radians
  theta = 2 * Math::PI * rand
  # random radius, use the square root to ensure a uniform
  # distribution of points over the circle
  r = Math.sqrt(rand) * max_degree_delta
  delta_lat, delta_long = [r * Math.cos(theta), r * Math.sin(theta)]
  [center[0] + delta_lat, center[1] + delta_long]
end

def to_degrees(*args)


converts each value and returns array.
If an array (or multiple arguments) is passed,
Convert radians to degrees.
#
def to_degrees(*args)
  args = args.first if args.first.is_a?(Array)
  if args.size == 1
    (args.first * 180.0) / Math::PI
  else
    args.map{ |i| to_degrees(i) }
  end
end

def to_kilometers(mi)


Convert miles to kilometers.
#
def to_kilometers(mi)
  mi * mi_in_km
end

def to_miles(km)


Convert kilometers to miles.
#
def to_miles(km)
  km * km_in_mi
end

def to_nautical_miles(km)


Convert kilometers to nautical miles.
#
def to_nautical_miles(km)
  km * km_in_nm
end

def to_radians(*args)


converts each value and returns array.
If an array (or multiple arguments) is passed,
Convert degrees to radians.
#
def to_radians(*args)
  args = args.first if args.first.is_a?(Array)
  if args.size == 1
    args.first * (Math::PI / 180)
  else
    args.map{ |i| to_radians(i) }
  end
end