geotree 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e790d44323caacbf4a2bd3ec69bc02bb55dc847
-  data.tar.gz: bdb2927e4dea7857cd9863cbc2b53ee0c089bef7
+  metadata.gz: d139e141c3f1de2d164a60d382a57dab14c145cb
+  data.tar.gz: a4e2951d2f513a39aac941e073dedb6f77a4b3bc
 SHA512:
-  metadata.gz: eef40796846cbabd4bddd8f32cef9334f7b4e6b0d17fcb851af0247907c8e89b9582808179bed41dc635069965e2c634a8c55e0fa5a1411f0ef09d23f4ca4980
-  data.tar.gz: e92b0f2e40906f8bc9853b21af28af24691a0b6d8e77682fd1fb8a557b36f9e520c33e092aa8b6ae4fe2f47eb78035460d901b8744c85bd56c5d5e4a6be4e329
+  metadata.gz: ec83653bcabfe8121c7954dc80550acb11f8578b4eb58b55a989450369b99d2b4d353008c4584d4d7dea6aaf0aab91ed77b3f7abd12086d64f27dd8aa826849f
+  data.tar.gz: 51fd669841ada4aae664cf500c63e8f358c4c596d4e9860d48075278de0365a82c78f5c7f78b99a5bb8786dd282b21f152aca973dee0dbb7197079ca5d76af8b

data/CHANGELOG.txt

@@ -1,3 +1,7 @@
-2013-04-02 Jeff Sember jpsember@gmail.com
-  * Version 1.0.0 released
+2013-04-02  
+  * Version 1.0.0  
 
+2013-04-03  
+  * Version 1.0.1 
+  * Enhanced README file
+  

data/README.txt

@@ -1,6 +1,31 @@
-geotree : xxx
+# @markup markdown
 
+'geotree' : A ruby gem that maintains a set of geographical points, reports points lying within a query rectangle,
+and supports multiple levels of detail.
+=======
 Written and (c) by Jeff Sember, April 2013.
-================================================================================
 
 
+
+GeoTree
+-------
+
+A GeoTree  is a variant of a k-d tree, and stores data points that have a latitude 
+and longitude, a unique integer identifier, and an optional 'weight' (e.g., the 
+size of a city).  GeoTrees are disk-based data structures and can store a very large 
+number of points efficiently.  If desired, for smaller data sets, memory-only trees 
+can be constructed instead.
+
+[An animation of a GeoTree in action.](../geotree/lib/fig/geo_tree.pdf "geo_tree.pdf")
+
+MultiTree
+-------
+
+
+The gem includes MultiTree, a GeoTree variant that supports queries at multiple 
+levels of detail. For example, when focusing on a small region it can return points 
+that would be omitted when querying a much larger region.
+
+[An animation of a MultiTree in action.](../geotree/lib/fig/multi_tree.pdf "multi_tree.pdf")
+
+ 

data/lib/geotree/geotree.rb

@@ -3,7 +3,7 @@ require_relative 'node'
 req 'diskblockfile ptbuffer'
 
 module GeoTreeModule
-  
+  #
   # A variant of a kd-tree, it is capable of maintaining sets of 2D points and efficiently
   # reporting all points lying within (axis-aligned) query rectangles.    
   #
@@ -14,6 +14,8 @@ module GeoTreeModule
   # A GeoTree is usually stored within a disk file, though it is also possible to
   # construct a tree that exists only in memory; see the initialize(...) method.
   #
+  # {An animation of a GeoTree in action.}[link:../../doc/geo_tree.pdf]   
+  #
   # Usage:
   #
   # [] Open a tree.  If no tree exists, a new, empty one is created.
@@ -71,7 +73,7 @@ module GeoTreeModule
   #      Otherwise, (i) the datapoints can be retrieved from the tree to an array 
   #      (by using a sufficiently large query rectangle), (ii) a new tree can be constructed, 
   #      and (iii) each of the points in the array can be added to the new tree.
-  #      
+  #   
   class GeoTree
 
     ROOT_NODE_NAME_ = BlockFile::FIRST_BLOCK_ID

data/lib/geotree/multitree.rb

@@ -16,6 +16,8 @@ module GeoTreeModule
   # When querying a MultiTree, the user must specify which level of detail (i.e.,
   # which of the contained trees) is to be examined.   
   #
+  #  {An animation of a MultiTree in action.}[link:../../doc/multi_tree.pdf]   
+  #
   class MultiTree
 
     attr_reader :num_trees

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geotree
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Jeff Sember
@@ -14,7 +14,7 @@ description: "  \nA GeoTree  is a variant of a k-d tree, and stores data points
   have a latitude and longitude, \na unique integer identifier, and an optional 'weight'
   (e.g., the size of a city).  \nGeoTrees are disk-based data structures and can store
   a very large number of points efficiently.\nIf desired, for smaller data sets, memory-only
-  trees can be constructed instead.\n\nThe gem includes MultiTrees, a GeoTree variant
+  trees can be constructed instead.\n\nThe gem includes MultiTree, a GeoTree variant
   that supports queries at \nmultiple levels of detail. For example, when focusing
   on a \nsmall region it can return points that would be omitted when querying a much
   larger region.\n\nAnimations illustrating GeoTrees and MultiTrees in action can
@@ -37,6 +37,8 @@ files:
 - lib/geotree/pswriter.rb
 - lib/geotree/ptbuffer.rb
 - lib/geotree/tools.rb
+- lib/fig/geo_tree.pdf
+- lib/fig/multi_tree.pdf
 - CHANGELOG.txt
 - README.txt
 - test/test_blockfile.rb