distance_measures 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,48 @@
+= Distance Measures
+
+A bunch of distance measures that extend Array.
+
+== Install
+
+  gem sources -a http://gemcutter.org
+  sudo gem install distance_measures
+  
+== How to use
+
+  a = [1,1]
+  b = [2,2]
+  
+  a.euclidean_distance(b)
+  
+  a.cosine_similarity(b)
+  
+  a.jaccard_index(b)
+  
+  a.jaccard_distance(b)
+  
+  a.binary_jaccard_index(b)
+  
+  a.binary_jaccard_distance(b)
+  
+  a.tanimoto_coefficient(b)
+  
+This may or may not be the complete list, best thing is to check the source code.
+  
+There are also a couple bonus methods:
+
+  a.dot_product(b)
+  
+  a.sum_of_squares
+  
+  a.intersection_with(b)
+  
+  a.union_with(b)
+  
+  # When your dealing with 1's and 0's
+  a.binary_intersection_with(b)
+  
+  a.binary_union_with(b)
+
+== Copyright
+
+Copyright (c) 2010 reddavis. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "distance_measures"
+    gem.summary = %Q{A bundle of distance measures}
+    gem.description = %Q{A bundle of distance measures}
+    gem.email = "reddavis@gmail.com"
+    gem.homepage = "http://github.com/reddavis/distance_measure"
+    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: 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 = "distance_measure #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/distance_measures.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{distance_measures}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["reddavis"]
+  s.date = %q{2010-01-25}
+  s.description = %q{A bundle of distance measures}
+  s.email = %q{reddavis@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "distance_measures.gemspec",
+     "lib/distance_measures.rb",
+     "lib/distance_measures/core.rb",
+     "lib/distance_measures/cosine_similarity.rb",
+     "lib/distance_measures/euclidean_distance.rb",
+     "lib/distance_measures/jaccard.rb",
+     "lib/distance_measures/tanimoto_coefficient.rb",
+     "spec/distance_measures_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/reddavis/distance_measure}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A bundle of distance measures}
+  s.test_files = [
+    "spec/distance_measures_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/distance_measures/core.rb

@@ -0,0 +1,60 @@
+module DistanceMeasures
+  def dot_product(other)
+    sum = 0.0
+    self.each_with_index do |n, index|
+      sum += n * other[index]
+    end
+    
+    sum
+  end
+  
+  def euclidean_normalize
+    sum = 0.0
+    self.each do |n|
+      sum += n ** 2
+    end
+    
+    Math.sqrt(sum)
+  end
+  
+  def sum_of_squares
+    inject(0) {|sum, n| sum + n ** 2}
+  end
+  
+  # http://en.wikipedia.org/wiki/Intersection_(set_theory)
+  def intersection_with(other)
+    (self & other)
+  end
+  
+  # http://en.wikipedia.org/wiki/Union_(set_theory)
+  def union_with(other)
+    (self + other).uniq
+  end
+  
+  # 1's & 0's
+  def binary_intersection_with(other)
+    intersects = []
+    self.each_with_index do |n, index|
+      if n == 1 && other[index] == 1
+        intersects << 1
+      else
+        intersects << 0
+      end
+    end
+    
+    intersects
+  end
+  
+  def binary_union_with(other)
+    unions = []
+    self.each_with_index do |n, index|
+      if n == 1 || other[index] == 1
+        unions << 1
+      else
+        unions << 0
+      end
+    end
+    
+    unions
+  end
+end

data/lib/distance_measures/cosine_similarity.rb

@@ -0,0 +1,9 @@
+# http://en.wikipedia.org/wiki/Cosine_similarity
+module DistanceMeasures
+  def cosine_similarity(other)
+    dot_product = self.dot_product(other)
+    normalization = self.euclidean_normalize * other.euclidean_normalize
+        
+    dot_product / normalization
+  end
+end

data/lib/distance_measures/euclidean_distance.rb

@@ -0,0 +1,10 @@
+# http://en.wikipedia.org/wiki/Euclidean_distance
+module DistanceMeasures
+  def euclidean_distance(other)
+    sum = 0.0
+    self.each_index do |i|
+      sum += (self[i] - other[i])**2
+    end
+    Math.sqrt(sum)
+  end
+end

data/lib/distance_measures/jaccard.rb

@@ -0,0 +1,26 @@
+# http://en.wikipedia.org/wiki/Jaccard_coefficient
+module DistanceMeasures
+  
+  def jaccard_distance(other)
+    1 - self.jaccard_index(other)
+  end
+  
+  def jaccard_index(other)
+    union = (self + other).uniq.size.to_f
+    intersection = self.intersection_with(other).size.to_f
+        
+    intersection / union
+  end
+  
+  def binary_jaccard_distance(other)
+    1 - self.binary_jaccard_index(other)
+  end
+  
+  def binary_jaccard_index(other)
+    intersection = self.binary_intersection_with(other).delete_if {|x| x == 0}.size.to_f
+    union = self.binary_union_with(other).delete_if {|x| x == 0}.size.to_f
+    
+    intersection / union
+  end
+  
+end

data/lib/distance_measures/tanimoto_coefficient.rb

@@ -0,0 +1,7 @@
+# http://en.wikipedia.org/wiki/Jaccard_index#Tanimoto_coefficient_.28extended_Jaccard_coefficient.29
+module DistanceMeasures
+  def tanimoto_coefficient(other)
+    dot = self.dot_product(other).to_f
+    dot / (self.sum_of_squares + other.sum_of_squares - dot).to_f
+  end
+end

data/lib/distance_measures.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'distance_measures/cosine_similarity'
+require 'distance_measures/euclidean_distance'
+require 'distance_measures/tanimoto_coefficient'
+require 'distance_measures/core'
+require 'distance_measures/jaccard'
+
+class Array
+  include DistanceMeasures
+end

data/spec/distance_measures_spec.rb

@@ -0,0 +1,93 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DistanceMeasures" do
+  
+  describe "Euclidean Distance" do
+    it "should return 1" do
+      array.euclidean_distance(array).should == 0.0
+    end
+  end
+  
+  describe "Cosine Similarity" do
+    it "should return 1.0" do
+      array.cosine_similarity(array).should > 0.99
+    end
+  end
+  
+  describe "Tanimoto Coefficient" do
+    it "should return 1.0" do
+      array.tanimoto_coefficient(array).should == 1.0
+    end
+  end
+  
+  describe "Sum of Squares" do
+    it "should return 50" do
+      array.sum_of_squares.should == 50
+    end
+  end
+  
+  describe "Jaccard" do
+    describe "Jaccard Distance" do
+      it "should return" do
+        array_2.jaccard_distance(array_3).should == (1 - 3.0/7.0)
+      end
+    end
+    
+    describe "Jaccard Index" do
+      it "should return" do
+        array_2.jaccard_index(array_3).should == 3.0/7.0
+      end
+    end
+    
+    describe "Binary Jaccard Index" do
+      it "should return 1/4" do
+        [1,1,1,1].binary_jaccard_index([0,1,0,0]).should == 1/4.0
+      end
+    end
+  end
+  
+  describe "Binary Jaccard Distance" do
+    it "should return 0.75" do
+      [1,1,1,1].binary_jaccard_distance([0,1,0,0]).should == 1 - (1/4.0)
+    end
+  end
+  
+  describe "Intersection" do
+    it "should return [7,4,1]" do
+      array_2.intersection_with(array_3).should == [7,4,1]
+    end
+  end
+  
+  describe "Union" do
+    it "should return " do
+      array_2.union_with(array_3).should == [7,3,2,4,1,9,5] 
+    end
+  end
+  
+  describe "Binary Intersection" do
+    it "should return [0,1,0,0]" do
+      [1,1,1,1].binary_intersection_with([0,1,0,0]).should == [0,1,0,0]
+    end
+  end
+  
+  describe "Binary Union" do
+    it "should return [1,1,1,0]" do
+      [1,1,1,0].binary_union_with([0,0,0,0]).should == [1,1,1,0]
+    end
+  end
+  
+  private
+    
+  def array
+    [5, 5]
+  end
+  
+  def array_2
+    [7, 3, 2, 4, 1]
+  end
+  
+  def array_3
+    [4,1,9,7,5]
+  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 'distance_measures'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: distance_measures
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- reddavis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-25 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: A bundle of distance measures
+email: reddavis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- distance_measures.gemspec
+- lib/distance_measures.rb
+- lib/distance_measures/core.rb
+- lib/distance_measures/cosine_similarity.rb
+- lib/distance_measures/euclidean_distance.rb
+- lib/distance_measures/jaccard.rb
+- lib/distance_measures/tanimoto_coefficient.rb
+- spec/distance_measures_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/reddavis/distance_measure
+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: A bundle of distance measures
+test_files: 
+- spec/distance_measures_spec.rb
+- spec/spec_helper.rb