knn 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 reddavis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= K Nearest Neighbours
+
+Simple KNN Ruby implementation
+
+== Install
+
+  gem sources -a -http://gemcutter.org
+  sudo gem install naive_bayes
+
+== How To Use
+
+  require 'rubygems'
+  require 'knn'
+  
+  data = Array.new(100000) { Array.new(4) { rand } }
+
+  knn = KNN.new(data)
+  
+  knn.nearest_neighbours([1,2,3,4], 4)  # ([data], k's)
+    #=> [[4837, 7.43033158269445, [0.966558570073977, 0.903158898673566, 0.954567901514261, 0.988114355901207]], ...
+    
+  # Data is returned in the format
+  # [data index, distance to the input, [data points]]
+  
+  # So if we called queried the data array for 4837...
+  data[4837]
+    #=> [0.966558570073977, 0.903158898673566, 0.954567901514261, 0.988114355901207]
+
+== Copyright
+
+Copyright (c) 2009 Red Davis. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "knn"
+    gem.summary = %Q{Simple K Nearest Neighbour algorithm}
+    gem.description = %Q{Simple K Nearest Neighbour algorithm}
+    gem.email = "reddavis@gmail.com"
+    gem.homepage = "http://github.com/reddavis/knn"
+    gem.authors = ["reddavis"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "k_nearest_neighbours #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/examples/example_one.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/knn')
+require 'benchmark'
+
+data = Array.new(10000) { Array.new(4) { rand } }
+
+knn = KNN.new(data)
+
+Benchmark.bm do |x|
+  x.report { puts knn.nearest_neighbours([3,4,5,6], 4).inspect }
+end

data/lib/ext/array.rb

@@ -0,0 +1,9 @@
+class Array
+  def euclidean_distance_from(other)
+    sum = 0.0
+    self.each_with_index do |datum, index|
+      sum += (datum - other[index]) ** 2
+    end
+    Math.sqrt(sum)
+  end
+end

data/lib/knn.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/ext/array')
+
+class KNN
+  def initialize(data)
+    @data = data
+  end
+  
+  def nearest_neighbours(input, k=4)
+    find_closest_data(input, k)
+  end
+  
+  private
+  
+  def find_closest_data(input, k)
+    calculated_distances = []
+    
+    @data.each_with_index do |datum, index| #Ye olde english
+      distance = input.euclidean_distance_from(datum)
+      calculated_distances << [index, distance, datum]
+    end
+    
+    calculated_distances.sort {|x, y| x[1] <=> y[1]}.first(k)
+  end  
+end

data/spec/ext/array_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Array" do
+  describe "Euclidean Distance" do
+    it "should return 0" do
+      [0,0].euclidean_distance_from([0,0]).should == 0
+    end
+    
+    it "should return 1" do
+      [0,0].euclidean_distance_from([0,1]).should == 1
+    end
+  end
+end

data/spec/knn_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "KNN" do
+  before do
+    @knn = KNN.new(data)
+  end
+  
+  it "should return 2 nearest neighbours (50,52 10,11)" do
+    neighbours = @knn.nearest_neighbours([60,60], 2)
+    neighbours.size.should == 2
+    neighbours.map {|x| x[2]}.should include([50,52], [10,11])
+  end
+  
+  private
+  
+  def data
+    [[1,2], [5,6], [10,11], [50,52]]
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'knn'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: knn
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- reddavis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-07 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Simple K Nearest Neighbour algorithm
+email: reddavis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/example_one.rb
+- lib/ext/array.rb
+- lib/knn.rb
+- spec/ext/array_spec.rb
+- spec/knn_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/reddavis/knn
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple K Nearest Neighbour algorithm
+test_files: 
+- spec/ext/array_spec.rb
+- spec/knn_spec.rb
+- spec/spec_helper.rb
+- examples/example_one.rb