kdtree 0.3 → 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d1d98fec6ed9f4ce19cd558098cbe6038c9d77d
+  data.tar.gz: 4b2f5d14367f4210146a7dea6e0e6dbd62ba9077
+SHA512:
+  metadata.gz: 68331f4219424518d298fa21b5aec5dd6353909a2e0fec61202894fd7b87aeb91d35761afee2b28f1edfc73547834e790b4ee414b18f40b5eab4c4b67d132c87
+  data.tar.gz: 506bd2057fec9dd7f9a82132e947ee37fdf2533ed70fa6c721e4643b113f884e32a8f4219ec20459b1e6a812031ff97b3cccf1b71ea93daf3a31941a87a99a1c

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
+.ruby-version
 Gemfile.lock
 lib/*.so
+lib/kdtree.bundle
 tmp

data/.travis.yml

@@ -1,9 +1,7 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - rbx-18mode
-  - rbx-19mode
-#  - ruby-head
-  - ree
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0

data/README.md

@@ -1,24 +1,50 @@
 ## Kdtree
 
+[![Build Status](https://travis-ci.org/gurgeous/kdtree.svg?branch=master)](https://travis-ci.org/gurgeous/kdtree)
+
 A kd tree is a data structure that recursively partitions the world in order to rapidly answer nearest neighbor queries. A generic kd tree can support any number of dimensions, and can return either the nearest neighbor or a set of N nearest neighbors.
 
 This gem is a blazingly fast, native, 2d kdtree. It's specifically built to find the nearest neighbor when searching millions of points. It's used in production at Urbanspoon and several other companies.
 
 The first version of this gem was released back in 2009. See the original [blog post](http://gurge.com/2009/10/22/ruby-nearest-neighbor-fast-kdtree-gem/) for the full story. Wikipedia has a great [article on kdtrees](http://en.wikipedia.org/wiki/K-d_tree).
 
+Note: kdtree 0.3 obsoletes these forks: ghazel-kdtree, groupon-kdtree, tupalo-kdree. Thanks guys!
+
 ### Usage
 
-Usage is very simple:
+First, install kdtree:
+
+```sh
+$ sudo gem install kdtree
+```
+
+It's easy to use:
 
-* **Kdtree.new(points)** - construct a new tree. Each point should be of the form `[x, y, id]`, where `x/y` are floats and `id` is an int. Not a string, not an object, just an int.
+* **Kdtree.new(points)** - construct a new tree. Each point should be of the form `[x, y, id]`, where `x/y` are floats and `id` is an int. Not a string, not an object, **just an int**.
 * **kd.nearest(x, y)** - find the nearest point. Returns an id.
 * **kd.nearestk(x, y, k)** - find the nearest `k` points. Returns an array of ids.
 
-Also, I made it possible to **persist** the tree to disk and load it later. That way you can calculate the tree offline and load it quickly at some future point. Loading a persisted tree w/ 1 millions points takes less than a second, as opposed to the 3.5 second startup time shown above. For example:
+For example:
+
+```ruby
+# construct the tree
+points = []
+points << [47.6, -122.3, 1] # Seattle id=1
+points << [45.5, -122.8, 2] # Portland id=2
+points << [40.7, -74.0,  3] # New York id=3
+kd = Kdtree.new(points)
+
+# which city is closest to San Francisco?
+p kd.nearest(34.1, -118.2) # => 2
+# which two cities are closest to San Francisco?
+p kd.nearestk(34.1, -118.2, 2) # => [2, 1]
+```
+
+Also, I made it possible to **persist** the tree to disk and load it later. That way you can calculate the tree offline and load it quickly at some future point. Loading a persisted tree w/ 1 millions points takes half a second, as opposed to the 3.5 second build time shown below. At Urbanspoon we persist the tree and rsync it out to other machines. For example:
 
 ```ruby
 File.open("treefile", "w") { |f| kd.persist(f) }
-... later ...
+# ... later ...
 kd2 = File.open("treefile") { |f| Kdtree.new(f) }
 ```
 
@@ -27,16 +53,19 @@ kd2 = File.open("treefile") { |f| Kdtree.new(f) }
 Kdtree is fast. How fast? Using a tree with 1 million points on my i5 2.8ghz:
 
 ```
-build               3.5s
+build (init)        3.52s
 nearest point       0.000003s
 nearest 5 points    0.000004s
 nearest 50 points   0.000014s
 nearest 255 points  0.000063s
+
+persist             0.301963s
+read (init)         0.432676s
 ```
 
 ### Limitations
 
-* No **editing** allowed! Once you construct a tree you&#8217;re stuck with it.
+* No **editing** allowed! Once you construct a tree you're stuck with it.
 * The tree is stored in **one big memory block**, 20 bytes per point. A tree with one million points will allocate a single 19mb block to store its nodes.
 * Persisted trees are **architecture dependent**, and may not work across different machines due to endian issues.
 * nearestk is limited to **255 results**
@@ -52,7 +81,7 @@ Since this gem was originally released, several folks have contributed important
 
 ### Changelog
 
-#### 0.3 (in progress, unreleased)
+#### 0.3
 
 * Ruby 1.9.x compatibility (@mcerna and others)
 * renamed KDTree to the more idiomatic Kdtree

data/Rakefile

@@ -13,11 +13,11 @@ task :build do
   system "gem build --quiet kdtree.gemspec"
 end
 
-task :install => :build do
+task install: :build do
   system "sudo gem install --quiet kdtree-#{spec.version}.gem"
 end
 
-task :release => :build do
+task release: :build do
   system "git tag -a #{spec.version} -m 'Tagging #{spec.version}'"
   system "git push --tags"
   system "gem push kdtree-#{spec.version}.gem"
@@ -37,5 +37,5 @@ Rake::ExtensionTask.new("kdtree", spec)
 Rake::TestTask.new(:test) do |test|
   test.libs << "test"
 end
-task :test => :compile
-task :default => :test
+task test: :compile
+task default: :test

data/ext/kdtree/kdtree.c

@@ -278,7 +278,7 @@ static void kdtree_nearest0(struct kdtree_data *kdtreep, int i, float x, float y
  *   kd = Kdtree.new(points)
  *
  *   # which two cities are closest to San Francisco?
- *   kd.nearest(34.1, -118.2) #=> [2, 1]
+ *   kd.nearestk(34.1, -118.2, 2) #=> [2, 1]
  */
 static VALUE kdtree_nearestk(VALUE kdtree, VALUE x, VALUE y, VALUE k)
 {
@@ -481,7 +481,7 @@ static void write_all(VALUE io, const void *buf, int len)
  *   # which city is closest to San Francisco?
  *   kd.nearest(34.1, -118.2) #=> 2
  *   # which two cities are closest to San Francisco?
- *   kd.nearest(34.1, -118.2) #=> [2, 1]
+ *   kd.nearestk(34.1, -118.2, 2) #=> [2, 1]
  *
  * For more information on kd trees, see:
  *

data/kdtree.gemspec

@@ -1,10 +1,11 @@
 Gem::Specification.new do |s|
   s.name        = "kdtree"
-  s.version     = "0.3"
+  s.version     = "0.4"
 
   s.authors     = ["Adam Doppelt"]
   s.email       = ["amd@gurge.com"]
   s.homepage    = "http://github.com/gurgeous/kdtree"
+  s.license     = "MIT"
   s.summary     = "Blazingly fast, native 2d kdtree."
   s.description = <<EOF
 A kdtree is a data structure that makes it possible to quickly solve
@@ -13,7 +14,8 @@ production use with millions of points.
 EOF
 
   s.rubyforge_project = "kdtree"
-  s.add_development_dependency "rake-compiler"
+  s.add_development_dependency "minitest", "~> 5.0"
+  s.add_development_dependency "rake-compiler", "~> 1.0"
 
   s.files      = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")

data/test/test_kdtree.rb

@@ -1,13 +1,13 @@
 require "benchmark"
 require "kdtree"
 require "tempfile"
-require "test/unit"
+require "minitest/autorun"
 
 #
 # create a tree
 #
 
-class KdtreeTest < Test::Unit::TestCase
+class KdtreeTest < Minitest::Test
   TMP = "#{Dir.tmpdir}/kdtree_test"
 
   def setup
@@ -16,7 +16,7 @@ class KdtreeTest < Test::Unit::TestCase
   end
 
   def teardown
-    File.unlink(TMP) if File.exists?(TMP)
+    File.unlink(TMP) if File.exist?(TMP)
   end
 
   def test_nearest
@@ -72,7 +72,7 @@ class KdtreeTest < Test::Unit::TestCase
 
   def test_bad_magic
     File.open(TMP, "w") { |f| f.puts "That ain't right" }
-    assert_raise RuntimeError do
+    assert_raises RuntimeError do
       File.open(TMP, "r") { |f| Kdtree.new(f) }
     end
   end
@@ -83,7 +83,7 @@ class KdtreeTest < Test::Unit::TestCase
 
     [2, 10, 100].each do |len|
       File.open(TMP, "w") { |f| f.write(bytes[0, len]) }
-      assert_raise EOFError do
+      assert_raises EOFError do
         File.open(TMP, "r") { |f| Kdtree.new(f) }
       end
     end
@@ -110,9 +110,7 @@ class KdtreeTest < Test::Unit::TestCase
 
         ks.each do |k|
           bm.report "100 queries (#{k})" do
-            total = count = 0
             100.times do
-              tm = Time.now
               if k == 1
                 kdtree.nearest(rand_coord, rand_coord)
               else

metadata

@@ -1,39 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: kdtree
 version: !ruby/object:Gem::Version
-  version: '0.3'
-  prerelease: 
+  version: '0.4'
 platform: ruby
 authors:
 - Adam Doppelt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: ! 'A kdtree is a data structure that makes it possible to quickly solve
-
+        version: '1.0'
+description: |
+  A kdtree is a data structure that makes it possible to quickly solve
   the nearest neighbor problem. This is a native 2d kdtree suitable for
-
   production use with millions of points.
-
-'
 email:
 - amd@gurge.com
 executables: []
@@ -41,8 +49,8 @@ extensions:
 - ext/kdtree/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -53,33 +61,28 @@ files:
 - lib/kdtree.rb
 - test/test_kdtree.rb
 homepage: http://github.com/gurgeous/kdtree
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3094601017742930682
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3094601017742930682
 requirements: []
 rubyforge_project: kdtree
-rubygems_version: 1.8.21
+rubygems_version: 2.6.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Blazingly fast, native 2d kdtree.
-test_files: []
+test_files:
+- test/test_kdtree.rb