rgeo 0.3.3 → 0.3.4

data/lib/rgeo.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # RGeo main file
-# 
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# Copyright 2010-2012 Daniel Azuma
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -36,74 +36,74 @@
 
 # RGeo is a spatial data library for Ruby. It focuses on the storage and
 # manipulation of spatial data types such as points, lines, and polygons.
-# 
+#
 # RGeo comprises a number of modules. The "rgeo" gem provides a suite of
 # standard modules. Additional optional modules are provided by separate
 # gems with names of the form "<tt>rgeo-*</tt>".
-# 
+#
 # === Standard modules
-# 
+#
 # These are the standard modules provided by the "rgeo" gem.
-# 
+#
 # * RGeo::Feature contains interface specifications for spatial
 #   objects implemented by RGeo. These interfaces closely follow the OGC
 #   Simple Features Specifiation (SFS). This module forms the core of RGeo.
-# 
+#
 # * RGeo::CoordSys contains classes for representing spatial
 #   reference systems and coordinate transformations. For example, it
 #   includes a wrapper for the Proj4 library, supporting many geographic
 #   projections.
-# 
+#
 # * RGeo::Cartesian is a gateway for geometric data implementations
 #   that operate in Caresian (flat) coordinate systems. It also provides a
 #   basic pure ruby Cartesian implementation. This implementation does not
 #   cover all the geometric analysis operations defined by the SFS, but it
 #   does not require an external C library and is often sufficient for
 #   basic applications.
-# 
+#
 # * RGeo::Geos is another Cartesian implementation that wraps the
 #   GEOS library to provide a full, high-performance implementation of
 #   Cartesian geometry that includes every operation defined in the SFS.
 #   It requires GEOS 3.2 or later.
-# 
+#
 # * RGeo::Geographic contains spatial implementations that operate
 #   in latitude-longitude coordinates and are well-suited for geographic
 #   location based applications. Geographic spatial objects may also be
 #   linked to projections.
-# 
+#
 # * RGeo::WKRep contains tools for reading and writing spatial
 #   data in the OGC Well-Known Text (WKT) and Well-Known Binary (WKB)
 #   representations. It also supports common variants such as the PostGIS
 #   EWKT and EWKB representations.
-# 
+#
 # === Optional Modules
-# 
+#
 # Here is a partial list of optional modules available as separate gems.
-# 
+#
 # * <b>rgeo-geojson</b> provides the RGeo::GeoJSON module, containing
 #   tools for GeoJSON encoding and decoding of spatial objects.
-# 
+#
 # * <b>rgeo-shapefile</b> provides the RGeo::Shapefile module, containing
 #   tools for reading ESRI shapefiles.
-# 
+#
 # * <b>rgeo-activerecord</b> provides the RGeo::ActiveRecord module,
 #   containing some ActiveRecord extensions for spatial databases, and a
 #   set of common tools for ActiveRecord spatial database adapters.
-# 
+#
 # Several ActiveRecord adapters use RGeo. These include:
-# 
+#
 # * <b>mysqlspatial</b>, an adapter for MySQL spatial extensions based on
 #   the mysql adapter. Available as the activerecord-mysqlspatial-adapter
 #   gem.
-# 
+#
 # * <b>mysql2spatial</b>, an adapter for MySQL spatial extensions based on
 #   the mysql2 adapter. Available as the activerecord-mysql2spatial-adapter
 #   gem.
-# 
+#
 # * <b>spatialite</b>, an adapter for the SpatiaLite extension to the
 #   Sqlite3 database, and based on the sqlite3 adapter. Available as the
 #   activerecord-spatialite-adapter gem.
-# 
+#
 # * <b>postgis</b>, an adapter for the PostGIS extension to the PostgreSQL
 #   database, and based on the postgresql adapter. Available as the
 #   activerecord-postgis-adapter gem.

data/lib/rgeo/cartesian.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Cartesian features for RGeo
-# 
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# Copyright 2010-2012 Daniel Azuma
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -35,18 +35,18 @@
 
 
 module RGeo
-  
-  
+
+
   # The Cartesian module is a gateway to implementations that use the
   # Cartesian (i.e. flat) coordinate system. It provides convenient
   # access to Cartesian factories such as the Geos implementation and
   # the simple Cartesian implementation. It also provides a namespace
   # for Cartesian-specific analysis tools.
-  
+
   module Cartesian
   end
-  
-  
+
+
 end
 
 

data/lib/rgeo/cartesian/analysis.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
-# Cartesian toplevel interface
-# 
+#
+# Cartesian geometric analysis utilities
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# Copyright 2010-2012 Daniel Azuma
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -35,30 +35,30 @@
 
 
 module RGeo
-  
+
   module Cartesian
-    
-    
+
+
     # This provides includes some spatial analysis algorithms supporting
     # Cartesian data.
-    
+
     module Analysis
-      
+
       class << self
-        
-        
+
+
         # Given a LineString, which must be a ring, determine whether the
         # ring proceeds clockwise or counterclockwise.
         # Returns 1 for counterclockwise, or -1 for clockwise.
-        # 
+        #
         # Returns 0 if the ring is empty.
         # The return value is undefined if the object is not a ring, or
         # is not in a Cartesian coordinate system.
-        
+
         def ring_direction(ring_)
           size_ = ring_.num_points - 1
           return 0 if size_ == 0
-          
+
           # Extract unit-length segments from the ring.
           segs_ = []
           size_.times do |i_|
@@ -74,7 +74,7 @@ module RGeo
             end
           end
           segs_ << segs_[0] << segs_[1]
-          
+
           # Extract angles from the segments by subtracting the segments.
           # Note angles are represented as cos/sin pairs so we don't
           # have to calculate any trig functions.
@@ -83,7 +83,7 @@ module RGeo
             x0_, y0_, x1_, y1_ = segs_[i_*2,4]
             angs_ << x0_*x1_ + y0_*y1_ << x0_*y1_ - x1_*y0_
           end
-          
+
           # Now add the angles and count revolutions.
           # Again, our running sum is represented as a cos/sin pair.
           revolutions_ = 0
@@ -108,13 +108,13 @@ module RGeo
           end
           revolutions_
         end
-        
-        
+
+
       end
-      
+
     end
-    
-    
+
+
   end
-  
+
 end

data/lib/rgeo/cartesian/bounding_box.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
-# Cartesian toplevel interface
-# 
+#
+# Cartesian bounding box
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# Copyright 2010-2012 Daniel Azuma
+#
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
-# 
+#
 # * Redistributions of source code must retain the above copyright notice,
 #   this list of conditions and the following disclaimer.
 # * Redistributions in binary form must reproduce the above copyright notice,
@@ -18,7 +18,7 @@
 # * Neither the name of the copyright holder, nor the names of any other
 #   contributors to this software, may be used to endorse or promote products
 #   derived from this software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -35,50 +35,50 @@
 
 
 module RGeo
-  
+
   module Cartesian
-    
-    
+
+
     # This is a bounding box for Cartesian data.
     # The simple cartesian implementation uses this internally to compute
     # envelopes. You may also use it directly to compute and represent
     # bounding boxes.
-    # 
+    #
     # A bounding box is a set of ranges in each dimension: X, Y, as well
     # as Z and M if supported. You can compute a bounding box for one or
     # more geometry objects by creating a new bounding box object, and
     # adding the geometries to it. You may then query it for the bounds,
     # or use it to determine whether it encloses other geometries or
     # bounding boxes.
-    
+
     class BoundingBox
-      
-      
+
+
       # Create a new empty bounding box with the given factory.
-      # 
+      #
       # The factory defines the coordinate system for the bounding box,
       # and also defines whether it should track Z and M coordinates.
       # All geometries will be cast to this factory when added to this
       # bounding box, and any generated envelope geometry will have this
       # as its factory.
-      # 
+      #
       # Options include:
-      # 
+      #
       # [<tt>:ignore_z</tt>]
       #   If true, ignore z coordinates even if the factory supports them.
       #   Default is false.
       # [<tt>:ignore_m</tt>]
       #   If true, ignore m coordinates even if the factory supports them.
       #   Default is false.
-      
+
       def initialize(factory_, opts_={})
         @factory = factory_
         @has_z = !opts_[:ignore_z] && factory_.property(:has_z_coordinate) ? true : false
         @has_m = !opts_[:ignore_m] && factory_.property(:has_m_coordinate) ? true : false
         @min_x = @max_x = @min_y = @max_y = @min_z = @max_z = @min_m = @max_m = nil
       end
-      
-      
+
+
       def eql?(rhs_)  # :nodoc:
         rhs_.is_a?(BoundingBox) && @factory == rhs_.factory &&
           @min_x == rhs_.min_x && @max_x == rhs_.max_x &&
@@ -87,95 +87,95 @@ module RGeo
           @min_m == rhs_.min_m && @max_m == rhs_.max_m
       end
       alias_method :==, :eql?
-      
-      
+
+
       # Returns the bounding box's factory.
-      
+
       def factory
         @factory
       end
-      
-      
+
+
       # Returns true if this bounding box is still empty.
-      
+
       def empty?
         @min_x.nil?
       end
-      
-      
+
+
       # Returns true if this bounding box tracks Z coordinates.
-      
+
       def has_z
         @has_z
       end
-      
-      
+
+
       # Returns true if this bounding box tracks M coordinates.
-      
+
       def has_m
         @has_m
       end
-      
-      
+
+
       # Returns the minimum X, or nil if this bounding box is empty.
-      
+
       def min_x
         @min_x
       end
-      
-      
+
+
       # Returns the maximum X, or nil if this bounding box is empty.
-      
+
       def max_x
         @max_x
       end
-      
-      
+
+
       # Returns the minimum Y, or nil if this bounding box is empty.
-      
+
       def min_y
         @min_y
       end
-      
-      
+
+
       # Returns the maximum Y, or nil if this bounding box is empty.
-      
+
       def max_y
         @max_y
       end
-      
-      
+
+
       # Returns the minimum Z, or nil if this bounding box is empty.
-      
+
       def min_z
         @min_z
       end
-      
-      
+
+
       # Returns the maximum Z, or nil if this bounding box is empty.
-      
+
       def max_z
         @max_z
       end
-      
-      
+
+
       # Returns the minimum M, or nil if this bounding box is empty.
-      
+
       def min_m
         @min_m
       end
-      
-      
+
+
       # Returns the maximum M, or nil if this bounding box is empty.
-      
+
       def max_m
         @max_m
       end
-      
-      
+
+
       # Returns a point representing the minimum extent in all dimensions,
       # or nil if this bounding box is empty.
-      
+
       def min_point
         if @min_x
           extras_ = []
@@ -186,11 +186,11 @@ module RGeo
           nil
         end
       end
-      
-      
+
+
       # Returns a point representing the maximum extent in all dimensions,
       # or nil if this bounding box is empty.
-      
+
       def max_point
         if @min_x
           extras_ = []
@@ -201,12 +201,12 @@ module RGeo
           nil
         end
       end
-      
-      
+
+
       # Adjusts the extents of this bounding box to encompass the given
       # object, which may be a geometry or another bounding box.
       # Returns self.
-      
+
       def add(geometry_)
         case geometry_
         when BoundingBox
@@ -221,11 +221,11 @@ module RGeo
         end
         self
       end
-      
-      
+
+
       # Converts this bounding box to an envelope polygon.
       # Returns the empty collection if this bounding box is empty.
-      
+
       def to_geometry
         if @min_x
           extras_ = []
@@ -251,20 +251,20 @@ module RGeo
           @factory.collection([])
         end
       end
-      
-      
+
+
       # Returns true if this bounding box contains the given object,
       # which may be a geometry or another bounding box.
-      # 
+      #
       # Supports these options:
-      # 
+      #
       # [<tt>:ignore_z</tt>]
       #   Ignore the Z coordinate when testing, even if both objects
       #   have Z. Default is false.
       # [<tt>:ignore_m</tt>]
       #   Ignore the M coordinate when testing, even if both objects
       #   have M. Default is false.
-      
+
       def contains?(rhs_, opts_={})
         if Feature::Geometry === rhs_
           contains?(BoundingBox.new(@factory).add(rhs_))
@@ -282,8 +282,8 @@ module RGeo
           true
         end
       end
-      
-      
+
+
       def _add_geometry(geometry_)  # :nodoc:
         case geometry_
         when Feature::Point
@@ -302,8 +302,8 @@ module RGeo
           geometry_.each{ |g_| _add_geometry(g_) }
         end
       end
-      
-      
+
+
       def _add_point(point_)  # :nodoc:
         if @min_x
           x_ = point_.x
@@ -329,11 +329,11 @@ module RGeo
           @min_m = @max_m = point_.m if @has_m
         end
       end
-      
-      
+
+
     end
-    
-    
+
+
   end
-  
+
 end