damerau-levenshtein 0.5.1 → 0.5.2

data/README.rdoc

@@ -1,8 +1,64 @@
 = damerau-levenshtein
 
+The damerau-levenshtein gem allows to find edit distance between two UTF-8 or ASCII encoded strings with O(N**2) efficiency.
 
-Description goes here.
+This gem implements pure Levenshtein algorithm, Damerau modification of it (where 2 character transposition counts as 1 edit distance).
+It also includes Boehmer & Rees 2008 modification of Damerau algorithm, where transposition of bigger than 1 character blocks is taken as 1 edit distance as well (Boehmer & Rees 2008).
+    
+    require 'damerau-levenshtein'
+    DamerauLevenshtein.distance('Something', 'Smoething') #returns 1
 
+Gem damerau-levenshtein is compatible with ruby versions 1.8.7 and 1.9.2 and higher
+
+== Installation
+  
+    gem install damerau-levenshtein
+
+== Examples
+    
+    require 'rubygems' #not needed for ruby >= 1.9.0
+    require 'damerau-levenshtein'
+    dl = DamerauLevenshtein
+
+* compare using Damerau Levenshtein algorithm
+
+    dl.distance("Something", "Smoething") #returns 1
+
+* compare using Levensthein algorithm
+  
+    dl.distance("Something", "Smoething", 0) #returns 2
+
+* compare using Boehmer & Rees modification
+
+    dl.distance("Something", "meSothing", 2) #returns 2 instead of 4
+
+* comparison of words with utf-8 characters should work fine:
+
+    dl.distance("Sjöstedt", "Sjostedt") #returns 1
+
+== Description
+
+DamerauLevenshtein.distance takes 4 arguments:
+
+* string1
+* string2
+* block_size (default is 1)
+* max_distance (default is 10)
+
+block_size determines maximum number of characters in a transposition block:
+
+    block_size = 0 (transposition does not count -- it is a pure Levenshtein algorithm)
+    block_size = 1 (transposition between 2 adjustent characters -- it is pure Damerau-Levenshtein algorithm)
+    block_size = 2 (transposition between blocks as big as 2 characters -- so abcd and cdab counts as edit distance 2, not 4)
+    block_size = 3 (transposition between blocks as big as 3 characters -- so abcdef and defabc counts as edit distance 3, not 6)
+    etc.
+
+max_distance -- is a threshold after which algorithm gives up and returns max_distance instead of real edit distance.
+
+Levenshtein algorithm is expensive, so it makes sense to give up when edit distance is becoming too big. The argument max_distance does just that.
+
+    DamerauLevenshtein.distance('abcdefg', '1234567', 0, 3) #give up when edit distance exceeds 3)
+    
 == Contributing to damerau-levenshtein
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/damerau-levenshtein.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{damerau-levenshtein}
+  s.version = "0.5.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dmitry Mozzherin"]
+  s.date = %q{2011-07-23}
+  s.description = %q{Calculation of editing distance for 2 strings using Levenshtein or Damerau-Levenshtein algorithms}
+  s.email = %q{dmozzherin@gmail.com}
+  s.extensions = ["ext/damerau_levenshtein_binding/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "damerau-levenshtein.gemspec",
+    "ext/damerau_levenshtein_binding/damerau_levenshtein_binding.c",
+    "lib/damerau-levenshtein.rb",
+    "spec/damerau-levenshtein_spec.rb",
+    "spec/damerau_levenshtein_test.txt",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/dimus/damerau-levenshtein}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Calculation of editing distance for 2 strings using Levenshtein or Damerau-Levenshtein algorithms}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake-compiler>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_development_dependency(%q<ruby-prof>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<rake-compiler>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_dependency(%q<ruby-prof>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake-compiler>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    s.add_dependency(%q<ruby-prof>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/ext/damerau_levenshtein_binding/damerau_levenshtein_binding.c

@@ -17,9 +17,15 @@ VALUE method_distance_utf(VALUE self, VALUE _s, VALUE _t, VALUE _block_size, VAL
   int stop_execution = 0;
   int min = 0;
   int current_distance = 0;
+  int pure_levenshtein = 0;
 
   int block_size = NUM2INT(_block_size);
   int max_distance = NUM2INT(_max_distance);
+  
+  if (block_size == 0) {
+    pure_levenshtein = 1;
+    block_size = 1;
+  }
 
   VALUE *sv = RARRAY_PTR(_s);
   VALUE *tv = RARRAY_PTR(_t);
@@ -87,7 +93,7 @@ VALUE method_distance_utf(VALUE self, VALUE _s, VALUE _t, VALUE _block_size, VAL
         min = del;
         if (ins < min) min = ins;
         //if (i == 2 && j==2) return INT2NUM(swap2+5);
-        if (block_size > 1 && i >= block && j >= block && swap1 == 1 && swap2 == 1){
+        if (pure_levenshtein == 0 && i >= block && j >= block && swap1 == 1 && swap2 == 1){
           transp = d[(j - block * 2) * sl + i - block * 2] + cost + block -1;
           if (transp < min) min = transp;
           block = 0;

data/lib/damerau-levenshtein.rb

@@ -2,10 +2,10 @@
 
 require 'damerau_levenshtein_binding'
 
-class DamerauLevenshtein
-  include DamerauLevenshteinBinding
+module DamerauLevenshtein
+  extend DamerauLevenshteinBinding
 
-  def distance(str1, str2, block_size = 2, max_distance = 10)
+  def self.distance(str1, str2, block_size = 1, max_distance = 10)
     distance_utf(str1.unpack("U*"), str2.unpack("U*"), block_size, max_distance)
   end
 end

data/spec/damerau-levenshtein_spec.rb

@@ -3,11 +3,10 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe "DamerauLevenshtein" do
   it 'should get tests' do
     read_test_file(File.expand_path(File.dirname(__FILE__)) + '/damerau_levenshtein_test.txt', 5) do |y|
-      dl = DamerauLevenshtein.new
+      dl = DamerauLevenshtein
       if y
         res = dl.distance(y[0], y[1], y[3].to_i, y[2].to_i)
         puts y if res != y[4].to_i
-        puts y
         res.should == y[4].to_i
       end
     end

data/spec/damerau_levenshtein_test.txt

@@ -48,24 +48,24 @@ Potamomus|Pomatomus|10|1|2
 # 1 utf-8 substitution
 Cedarinia scabra Sjöstedt 1921|Cedarinia scabra Sjostedt 1921|10|1|1
 # transposition (Levenshtein takes it as 2 substitutions)
-Pomatomus|oPmatomus|10|1|2
-Pomatomus|oPmatomus|10|2|1
+Pomatomus|oPmatomus|10|0|2
+Pomatomus|oPmatomus|10|1|1
 # transposition (Levenshtein takes it as 2 substitutions)
-Pomatomus|Pomatomsu|10|1|2
-Pomatomus|Pomatomsu|10|2|1
+Pomatomus|Pomatomsu|10|0|2
+Pomatomus|Pomatomsu|10|1|1
 # transposition
-Pomtaomus|Pomatomus|10|1|2
-Pomtaomus|Pomatomus|10|2|1
+Pomtaomus|Pomatomus|10|0|2
+Pomtaomus|Pomatomus|10|1|1
 # transposition
-Pomatoums|Pomatomus|10|1|2
-Pomatoums|Pomatomus|10|2|1
+Pomatoums|Pomatomus|10|0|2
+Pomatoums|Pomatomus|10|1|1
 # transposition + substitution
-PoamtosusPomatomus|10|1|3
-PoamtosusPomatomus|10|2|2
+PoamtosusPomatomus|10|0|3
+PoamtosusPomatomus|10|1|2
 
 # transposition with utf-8 char
-Cedarinia scabra Sjöstedt 1921|Cedarinia scabra Söjstedt 1921|10|1|2
-Cedarinia scabra Sjöstedt 1921|Cedarinia scabra Söjstedt 1921|10|2|1
+Cedarinia scabra Sjöstedt 1921|Cedarinia scabra Söjstedt 1921|10|0|2
+Cedarinia scabra Sjöstedt 1921|Cedarinia scabra Söjstedt 1921|10|1|1
 
 #it should calculate Modified Damerau Levenshtein distance with 2 or more characters transposition (block size > 2)
 serrulatus|serratulus|10|2|2

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 1
-  version: 0.5.1
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Dmitry Mozzherin
@@ -169,6 +169,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- damerau-levenshtein.gemspec
 - ext/damerau_levenshtein_binding/damerau_levenshtein_binding.c
 - lib/damerau-levenshtein.rb
 - spec/damerau-levenshtein_spec.rb
@@ -189,7 +190,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1891520829373669839
+      hash: 1769781403176282343
       segments: 
       - 0
       version: "0"