ngramdistance-ffi 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+README.markdown.html
+*.rbc
+pkg
+.*.sw?

data/CHANGELOG.markdown

@@ -0,0 +1,3 @@
+1.0.0
+-----
+* started

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gem 'ffi'
+
+group :test do
+  gem 'rspec', '1.3.1'
+  gem 'jeweler'
+end

data/README.markdown

@@ -0,0 +1,21 @@
+ ngramdistance-ffi
+===============
+
+Converted to FFI by Bali for Ruby portability.
+
+This gem originally based on ngram distance.
+
+Tested on:
+
+* MRI 1.9.2
+
+Known Issues
+============
+* The C extension uses `char*` strings, and so Unicode strings will give incorrect distances.
+
+Including in Gemfile
+====================
+
+    gem ' ngramdistance-ffi', :require => ' ngramdistance'
+
+- end -

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = " ngramdistance-ffi"
+    gemspec.summary = "An FFI version of the  ngramdistance gem."
+    gemspec.description = "Provides a fast, cross-Ruby implementation of the  ngramdistance distance algorithm."
+    gemspec.email = "dbalatero@gmail.com"
+    gemspec.homepage = "http://github.com/dbalatero/ ngramdistance-ffi"
+    gemspec.authors = ["Bali"]
+    gemspec.add_dependency "ffi"
+    gemspec.add_development_dependency "rspec"
+    gemspec.add_development_dependency "jeweler"
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/ext/ngramdistance/.gitignore

@@ -0,0 +1,3 @@
+*.bundle
+*.o
+Makefile

data/ext/ngramdistance/extconf.rb

@@ -0,0 +1,2 @@
+require 'mkmf'
+create_makefile('ngramdistance')

data/ext/ngramdistance/ngramdistance.c

@@ -0,0 +1,140 @@
+#include <string.h>
+#include <stdlib.h>
+#include <stdio.h>
+#ifdef NGRAM_CASE_INSENSITIVE
+  #include <ctype.h>
+  #define eq(x, y) (tolower(x) == tolower(y))
+#else
+  #define eq(x, y) ((x) == (y))
+#endif
+
+#ifndef max
+  #define max( a, b ) ( ((a) > (b)) ? (a) : (b) )
+#endif
+
+#ifndef min
+  #define min( a, b ) ( ((a) < (b)) ? (a) : (b) )
+#endif
+
+
+char* substring(const char* str, size_t begin, size_t len)
+{
+    if (str == 0 || strlen(str) == 0 || strlen(str) < begin || strlen(str) < (begin+len))
+        return 0;
+    
+    return strndup(str + begin, len);
+}
+
+
+float ngramdistance (const char *source, const char *target,int n) {
+    int sl = strlen(source);
+    int tl = strlen(target);
+    
+    if (sl == 0 || tl == 0) {
+        if (sl == tl) {
+            return 1;
+        }
+        else {
+            return 0;
+        }
+    }
+    int cost = 0;
+    if (sl < n || tl < n) {
+        int ni = min(sl,tl);
+        int i=0;
+        for (i=0;i<ni;i++) {
+            if (eq(source[i],target[i])) {
+                cost++;
+            }
+        }
+        return (float) cost/(float)max(sl, tl);
+    }
+    int char_len = sl+n-1;
+    char* sa = calloc(char_len+1,sizeof(char));
+      float* p; //'previous' cost array, horizontally
+      float* d; // cost array, horizontally
+      float* _d; //placeholder to assist in swapping p and d
+      
+      //construct sa with prefix
+      int i=0;
+      for (i=0;i<char_len;i++) {
+          if (i < n-1) {
+              sa[i]=0; //add prefix
+          }
+          else {
+              sa[i] = source[i-n+1];
+          }
+      }
+      int float_arr_len = sl+1;
+      p = calloc( float_arr_len+1 , sizeof( float)); 
+      d = calloc( float_arr_len+1 , sizeof( float)); 
+      
+      // indexes into strings s and t
+      i=0; // iterates through source
+      int j=0; // iterates through target
+      
+      char* t_j = calloc(n+1,sizeof(char)); // jth n-gram of t
+      for (i = 0; i<=sl; i++) {
+          p[i] = i;
+      }
+      
+      for (j = 1; j<=tl; j++) {
+          //construct t_j n-gram 
+          if (j < n) {
+              int ti=0;
+              for (ti=0;ti<n-j;ti++) {
+                  t_j[ti]=0; //add prefix
+              }
+              for (ti=n-j;ti<n;ti++) {
+                  t_j[ti]=target[ti-(n-j)];
+              }
+          }
+          else {
+              free (t_j);
+              t_j = substring(target,j-n, n);
+          }
+          d[0] = j;
+          for (i=1; i<=sl; i++) {
+              cost = 0;
+              int tn=n;
+              //compare sa to t_j
+              int ni=0;
+              for (ni=0;ni<n;ni++) {
+                  if (!eq(sa[i-1+ni] , t_j[ni])) {
+                      cost++;
+                  }
+                  else if (eq(sa[i-1+ni], 0)) { //discount matches on prefix
+                      tn--;
+                  }
+              }
+              float ec = (float) cost/(float)tn;
+              // minimum of cell to the left+1, to the top+1, diagonally left and up +cost
+              d[i] = min(min(d[i-1]+1, p[i]+1),  p[i-1]+ec);
+          }
+          // copy current distance counts to 'previous row' distance counts
+          _d = p;
+          p = d;
+          d = _d;
+      }
+      float val = p[sl];
+      free(p);
+      free(d);
+      free(t_j);
+      free(sa);
+      // our last action in the above loop was to switch d and p, so p now
+      // actually has the most recent cost counts
+      return 1.0f -  ((float) val / (float)max(tl, sl));
+}
+
+
+#ifdef TEST
+#include <stdio.h>
+#include "ngramdistance.h"
+                      
+  int main (int argc, char **argv) {
+      float distance;
+      if (argc < 3) return -1;
+      distance = ngramdistance(argv[1], argv[2],3);
+      printf("%s vs %s: %f\n", argv[1], argv[2],distance);
+  }
+#endif

data/ext/ngramdistance/ngramdistance.h

@@ -0,0 +1 @@
+unsigned ngramdistance(const char *, const char *, int n);

data/lib/ngramdistance.rb

@@ -0,0 +1,12 @@
+require 'ffi'
+
+module NGramDistance
+  extend FFI::Library
+
+  # Try loading in order.
+  library = File.dirname(__FILE__) + "/../ext/ngramdistance/ngramdistance"
+  candidates = ['.bundle', '.so', '.dylib', ''].map { |ext| library + ext }
+  ffi_lib(candidates)
+  
+  attach_function :distance, :ngramdistance, [:string, :string, :int], :float
+end

data/ngramdistance-ffi.gemspec

@@ -0,0 +1,64 @@
+# 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{ngramdistance-ffi}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bali"]
+  s.date = %q{2012-06-18}
+  s.description = %q{Provides a fast, cross-Ruby implementation of the  ngramdistance distance algorithm.}
+  s.email = %q{mailbali@gmail.com}
+  s.extensions = ["ext/ngramdistance/extconf.rb"]
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.markdown",
+     "Gemfile",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "ext/ngramdistance/.gitignore",
+     "ext/ngramdistance/extconf.rb",
+     "ext/ngramdistance/ngramdistance.c",
+     "ext/ngramdistance/ngramdistance.h",
+     "ngramdistance-ffi.gemspec",
+     "lib/ngramdistance.rb",
+     "spec/ngramdistance_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{https://github.com/pecbali/ngramdistance-ffi}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{An FFI version of the ngramdistance gem.}
+  s.test_files = [
+    "spec/ngramdistance_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::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ffi>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<ffi>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ffi>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/spec/ngramdistance_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe NGramDistance do
+  fixtures = [
+    ["university", "univearsitty", 0.750000,
+    ["university", "university", 1.0],
+    ["hello", "jello",0.633333],
+    ["hello", "heloll", 0.666667],
+    ["hello", "saint", 0.0000],
+    ["hello", "", 0.0000]
+  ]
+
+  fixtures.each do |w1, w2, d|
+    it "should calculate a distance of #{d} between #{w1} and #{w2}" do
+      NGramDistance.distance(w1, w2,3).should be_close( d,0.05)
+      NGramDistance.distance(w2, w1,3).should be_close d,0.05)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'spec'
+
+require File.dirname(__FILE__) + "/../lib/levenshtein"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: ngramdistance-ffi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Bali
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  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: Provides a fast, cross-Ruby implementation of the  ngramdistance distance
+  algorithm.
+email: mailbali@gmail.com
+executables: []
+extensions:
+- ext/ngramdistance/extconf.rb
+extra_rdoc_files:
+- README.markdown
+files:
+- .gitignore
+- CHANGELOG.markdown
+- Gemfile
+- README.markdown
+- Rakefile
+- VERSION
+- ext/ngramdistance/.gitignore
+- ext/ngramdistance/extconf.rb
+- ext/ngramdistance/ngramdistance.c
+- ext/ngramdistance/ngramdistance.h
+- ngramdistance-ffi.gemspec
+- lib/ngramdistance.rb
+- spec/ngramdistance_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pecbali/ngramdistance-ffi
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+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.24
+signing_key: 
+specification_version: 3
+summary: An FFI version of the ngramdistance gem.
+test_files:
+- spec/ngramdistance_spec.rb
+- spec/spec_helper.rb