added levenshtein edit distance calculator

[biopieces.git] / code_ruby / lib / maasha / levenshtein.rb

diff --git a/code_ruby/lib/maasha/levenshtein.rb b/code_ruby/lib/maasha/levenshtein.rb
index 1447e176890755e9d9e01447fd12c0db6fda19f8..bbc2c70ffc4f95f5985e747d9d4543d88b51f76a 100644 (file)
--- a/code_ruby/lib/maasha/levenshtein.rb
+++ b/code_ruby/lib/maasha/levenshtein.rb
@@ -24,6 +24,9 @@
 
 require 'inline'
 
+# Class to calculate the Levenshtein distance between two
+# given strings.
+# http://en.wikipedia.org/wiki/Levenshtein_distance
 class Levenshtein
   BYTES_IN_INT = 4
 
@@ -39,9 +42,6 @@ class Levenshtein
     l.distance_C(s, t, s.length, t.length, v0, v1)
   end
 
-  def initialize
-  end
-
   # >>>>>>>>>>>>>>> RubyInline C code <<<<<<<<<<<<<<<
 
   inline do |builder|
@@ -59,12 +59,12 @@ class Levenshtein
 
     builder.c %{
       VALUE distance_C(
-        VALUE _s,
-        VALUE _t,
-        VALUE _s_len,
-        VALUE _t_len,
-        VALUE _v0,
-        VALUE _v1
+        VALUE _s,       // string
+        VALUE _t,       // string
+        VALUE _s_len,   // string length
+        VALUE _t_len,   // string length
+        VALUE _v0,      // score vector
+        VALUE _v1       // score vector
       )
       {
         char         *s     = (char *) StringValuePtr(_s);