rb_kd_tree 0.0.1

data/ext/kd_tree/vendor/kdtree.h

@@ -0,0 +1,129 @@
+/*
+This file is part of ``kdtree'', a library for working with kd-trees.
+Copyright (C) 2007-2011 John Tsiombikas <nuclear@member.fsf.org>
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. The name of the author may not be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+OF SUCH DAMAGE.
+*/
+#ifndef _KDTREE_H_
+#define _KDTREE_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct kdtree;
+struct kdres;
+
+
+/* create a kd-tree for "k"-dimensional data */
+struct kdtree *kd_create(int k);
+
+/* free the struct kdtree */
+void kd_free(struct kdtree *tree);
+
+/* remove all the elements from the tree */
+void kd_clear(struct kdtree *tree);
+
+/* if called with non-null 2nd argument, the function provided
+ * will be called on data pointers (see kd_insert) when nodes
+ * are to be removed from the tree.
+ */
+void kd_data_destructor(struct kdtree *tree, void (*destr)(void*));
+
+/* insert a node, specifying its position, and optional data */
+int kd_insert(struct kdtree *tree, const double *pos, void *data);
+int kd_insertf(struct kdtree *tree, const float *pos, void *data);
+int kd_insert3(struct kdtree *tree, double x, double y, double z, void *data);
+int kd_insert3f(struct kdtree *tree, float x, float y, float z, void *data);
+
+/* Find the nearest node from a given point.
+ *
+ * This function returns a pointer to a result set with at most one element.
+ */
+struct kdres *kd_nearest(struct kdtree *tree, const double *pos);
+struct kdres *kd_nearestf(struct kdtree *tree, const float *pos);
+struct kdres *kd_nearest3(struct kdtree *tree, double x, double y, double z);
+struct kdres *kd_nearest3f(struct kdtree *tree, float x, float y, float z);
+
+/* Find the N nearest nodes from a given point.
+ *
+ * This function returns a pointer to a result set, with at most N elements,
+ * which can be manipulated with the kd_res_* functions.
+ * The returned pointer can be null as an indication of an error. Otherwise
+ * a valid result set is always returned which may contain 0 or more elements.
+ * The result set must be deallocated with kd_res_free after use.
+ */
+/*
+struct kdres *kd_nearest_n(struct kdtree *tree, const double *pos, int num);
+struct kdres *kd_nearest_nf(struct kdtree *tree, const float *pos, int num);
+struct kdres *kd_nearest_n3(struct kdtree *tree, double x, double y, double z);
+struct kdres *kd_nearest_n3f(struct kdtree *tree, float x, float y, float z);
+*/
+
+/* Find any nearest nodes from a given point within a range.
+ *
+ * This function returns a pointer to a result set, which can be manipulated
+ * by the kd_res_* functions.
+ * The returned pointer can be null as an indication of an error. Otherwise
+ * a valid result set is always returned which may contain 0 or more elements.
+ * The result set must be deallocated with kd_res_free after use.
+ */
+struct kdres *kd_nearest_range(struct kdtree *tree, const double *pos, double range);
+struct kdres *kd_nearest_rangef(struct kdtree *tree, const float *pos, float range);
+struct kdres *kd_nearest_range3(struct kdtree *tree, double x, double y, double z, double range);
+struct kdres *kd_nearest_range3f(struct kdtree *tree, float x, float y, float z, float range);
+
+/* frees a result set returned by kd_nearest_range() */
+void kd_res_free(struct kdres *set);
+
+/* returns the size of the result set (in elements) */
+int kd_res_size(struct kdres *set);
+
+/* rewinds the result set iterator */
+void kd_res_rewind(struct kdres *set);
+
+/* returns non-zero if the set iterator reached the end after the last element */
+int kd_res_end(struct kdres *set);
+
+/* advances the result set iterator, returns non-zero on success, zero if
+ * there are no more elements in the result set.
+ */
+int kd_res_next(struct kdres *set);
+
+/* returns the data pointer (can be null) of the current result set item
+ * and optionally sets its position to the pointers(s) if not null.
+ */
+void *kd_res_item(struct kdres *set, double *pos);
+void *kd_res_itemf(struct kdres *set, float *pos);
+void *kd_res_item3(struct kdres *set, double *x, double *y, double *z);
+void *kd_res_item3f(struct kdres *set, float *x, float *y, float *z);
+
+/* equivalent to kd_res_item(set, 0) */
+void *kd_res_item_data(struct kdres *set);
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif	/* _KDTREE_H_ */

data/kd_tree.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kd_tree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rb_kd_tree"
+  spec.version       = KdTree::VERSION
+  spec.authors       = ["Ryan Closner"]
+  spec.email         = ["ryan@ryanclosner.com"]
+  spec.description   = %q{A KDTree Library}
+  spec.summary       = %q{A KDTree Library}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/|^kd_tree$}) { |f| File.basename(f) }
+  spec.extensions    = ['ext/kd_tree/extconf.rb']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "ext"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "rspec"
+end

data/lib/kd_tree.rb

@@ -0,0 +1,5 @@
+require "kd_tree/version"
+require "kd_tree.so"
+
+module KdTree
+end

data/lib/kd_tree/version.rb

@@ -0,0 +1,3 @@
+module KdTree
+  VERSION = "0.0.1"
+end

data/spec/kd_tree_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+
+describe KDTree do
+
+  let(:nodes) { [[1,2,3], [4,5,6]] }
+  let(:dims) { 3 }
+
+  subject { described_class.new(nodes, dims) }
+
+  describe ".new" do
+    subject { described_class }
+
+    context "with valid arguments" do
+      it "returns an instance of KDTree" do
+        subject.new(nodes, dims).should be_a(KDTree)
+      end
+    end
+
+    context "with no nodes" do
+      let(:nodes) { nil }
+      it "raises an error" do
+        expect { subject.new(nodes, dims) }.to raise_error
+      end
+    end
+
+    context "with no dimensions" do
+      let(:dims) { nil }
+      it "raises an error" do
+        expect { subject.new(nodes, dims) }.to raise_error
+      end
+    end
+
+    context "with non-array nodes" do
+      let(:nodes) { {} }
+      it "raises an error" do
+        expect { subject.new(nodes, dims) }.to raise_error
+      end
+    end
+
+    context "with non-integer dimensions" do
+      let(:dims) { '3' }
+      it "raises an error" do
+        expect { subject.new(nodes, dims) }.to raise_error
+      end
+    end
+
+    context "with invalid dimensions" do
+      let(:dims) { 2 }
+      it "raises an error" do
+        expect { subject.new(nodes, dims) }.to raise_error
+      end
+    end
+
+  end
+
+  describe "#insert" do
+
+    let(:node) { [6,7,8] }
+
+    it "returns the inserted node" do
+      subject.insert(node).should == node
+    end
+
+    it "inserts the node into the tree" do
+      subject.insert(node)
+      res = subject.nearest_neighbor(node)
+      res.fetch("query").should == node
+      res.fetch("position").should == node
+      res.fetch("distance").should == 0.0
+    end
+
+  end
+
+  describe "#nearest_neighbor" do
+    let(:query) { nodes.first }
+
+    let(:response) { subject.nearest_neighbor(query) }
+
+    it "returns a hash" do
+      response.should be_a(Hash)
+    end
+
+    it "returns the query" do
+      response.fetch("query").should == query
+    end
+
+    it "returns the matched node" do
+      response.fetch("position").should == query
+    end
+
+    it "returns the distance" do
+      response.fetch("distance").should == 0.0
+    end
+
+    context "distance" do
+
+      # Query Node: [ 101, 102, 103 ]
+      # Expected Node: [ 4, 5, 6 ]
+      # Calculation: (101 - 4)^2 + (102 - 5)^2 + (103 - 6)^2 = 28227.0
+
+      let(:query) { nodes.first.map {|i| i + 100 } }
+
+      it "calculates correctly" do
+        response.fetch("distance").should == 28227.0
+      end
+
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+
+require File.expand_path('../../lib/kd_tree', __FILE__)

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rb_kd_tree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Closner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A KDTree Library
+email:
+- ryan@ryanclosner.com
+executables: []
+extensions:
+- ext/kd_tree/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/kd_tree/extconf.rb
+- ext/kd_tree/kd_tree.c
+- ext/kd_tree/vendor/kdtree.c
+- ext/kd_tree/vendor/kdtree.h
+- kd_tree.gemspec
+- lib/kd_tree.bundle
+- lib/kd_tree.rb
+- lib/kd_tree/version.rb
+- spec/kd_tree_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A KDTree Library
+test_files:
+- spec/kd_tree_spec.rb
+- spec/spec_helper.rb
+has_rdoc: