edits 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a437de45c8830ea622a9b57b84b3e92c54a58178
+  data.tar.gz: 36eff87bb3ba0e832f2cd908cb0bafe358e05a19
+SHA512:
+  metadata.gz: bf9474115aacaff6cb0411c85cf8f81409d6cfaff793ef656821fc1fc33ae0d5315aa6af98c8dbe17a68aa38514b8adef134824e2ea6fd8c1434aea372e37b6c
+  data.tar.gz: 71199e4c9e67f4b78b90e21368dfd1162cd660fa38b01e40ea412e1a37aa29529d57ee78f1e5584f5a6319a22b2134165b638335b0e75b163650aaadaa9d67ae

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.4
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - "tasks/**/*.rake"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.4

data/.yardopts

@@ -0,0 +1 @@
+-m markdown - LICENSE.txt

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in edits.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tom Crouch
+
+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.md

@@ -0,0 +1,98 @@
+# Edits
+
+A collection of edit distance algorithms in Ruby.
+
+Includes Levenshtein, Restricted Edit (Optimal Alignment) and Damerau-Levenshtein distances, and Jaro and Jaro-Winkler similarity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'edits'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install edits
+
+## Usage
+
+### Levenshtein
+
+Edit distance, accounting for deletion, addition and substitution.
+
+```ruby
+Edits::Levenshtein.distance "raked", "bakers"
+# => 3
+Edits::Levenshtein.distance "iota", "atom"
+# => 4
+Edits::Levenshtein.distance "acer", "earn"
+# => 4
+
+# Max distance
+Edits::Levenshtein.distance_with_max "iota", "atom", 2
+# => 2
+Edits::Levenshtein.most_similar "atom", %w[tram atlas rota racer]
+# => "atlas"
+```
+
+### Restricted Edit (Optimal Alignment)
+
+Edit distance, accounting for deletion, addition, substitution and swapped
+characters.
+
+```ruby
+Edits::RestrictedEdit.distance "raked", "bakers"
+# => 3
+Edits::RestrictedEdit.distance "iota", "atom"
+# => 3
+Edits::RestrictedEdit.distance "acer", "earn"
+# => 4
+```
+
+### Damerau-Levenshtein
+
+Edit distance, accounting for deletions, additions, substitution and
+transposition.
+
+```ruby
+Edits::DamerauLevenshtein.distance "raked", "bakers"
+# => 3
+Edits::DamerauLevenshtein.distance "iota", "atom"
+# => 3
+Edits::DamerauLevenshtein.distance "acer", "earn"
+# => 3
+```
+
+### Jaro & Jaro-Winkler
+
+```ruby
+Edits::Jaro.similarity "information", "informant"
+# => 0.90235690235690236
+Edits::Jaro.distance "information", "informant"
+# => 0.097643097643097643
+
+Edits::JaroWinkler.similarity "information", "informant"
+# => 0.94141414141414137
+Edits::JaroWinkler.distance "information", "informant"
+# => 0.05858585858585863
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tcrouch/edits.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Dir["tasks/**/*.rake"].each { |t| load t }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "edits"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/edits.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "edits/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "edits"
+  spec.version       = Edits::VERSION
+  spec.authors       = ["Tom Crouch"]
+  spec.email         = ["tom.crouch@gmail.com"]
+
+  spec.summary       = "A collection of edit distance algorithms."
+  # spec.description   = "TODO: Write a longer description or delete this line."
+  spec.homepage      = "https://github.com/tcrouch/edits"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "benchmark-ips", "~> 2.7"
+  spec.add_development_dependency "redcarpet", "~> 3.4"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

data/lib/edits.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "edits/version"
+
+require "edits/damerau_levenshtein"
+require "edits/hamming"
+require "edits/jaro"
+require "edits/jaro_winkler"
+require "edits/levenshtein"
+require "edits/restricted_edit"
+
+# A collection of edit distance algorithms
+module Edits
+  # Your code goes here...
+end

data/lib/edits/damerau_levenshtein.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Edits
+  # Implemention of the Damerau/Levenshtein distance algorithm.
+  #
+  # Determines distance between two strings by counting edits, identifying:
+  # * Insertion
+  # * Deletion
+  # * Substitution
+  # * Transposition
+  module DamerauLevenshtein
+    # Calculate the Damerau/Levenshtein distance of two sequences.
+    #
+    # @example
+    #   DamerauLevenshtein.distance("acer", "earn")
+    #   # => 3
+    # @param seq1 [String, Array]
+    # @param seq2 [String, Array]
+    # @return [Integer]
+    def self.distance(seq1, seq2)
+      if seq1.length > seq2.length
+        temp = seq1
+        seq1 = seq2
+        seq2 = temp
+      end
+
+      # array of Integer codepoints outperforms String
+      seq1 = seq1.codepoints if seq1.is_a? String
+      seq2 = seq2.codepoints if seq2.is_a? String
+
+      rows = seq1.length
+      cols = seq2.length
+      return cols if rows.zero?
+      return rows if cols.zero?
+
+      # 'infinite' edit distance for padding cost matrix.
+      # Can be any value greater than max[rows, cols]
+      inf = rows + cols
+
+      # Initialize first two rows of cost matrix.
+      # The full initial state where cols=3, rows=2 (inf=5) would be:
+      #   [[5, 5, 5, 5, 5],
+      #    [5, 0, 1, 2, 3],
+      #    [5, 1, 0, 0, 0],
+      #    [5, 2, 0, 0, 0]]
+      matrix = [Array.new(cols + 2, inf)]
+      matrix << 0.upto(cols).to_a.unshift(inf)
+
+      # element => last row seen
+      item_history = Hash.new(0)
+
+      1.upto(rows) do |row|
+        # generate next row of cost matrix
+        new_row = Array.new(cols + 2, 0)
+        new_row[0] = inf
+        new_row[1] = row
+        matrix << new_row
+
+        last_match_col = 0
+        seq1_item = seq1[row - 1]
+
+        1.upto(cols) do |col|
+          seq2_item = seq2[col - 1]
+          last_match_row = item_history[seq2_item]
+
+          sub_cost = seq1_item == seq2_item ? 0 : 1
+
+          transposition = 1 + matrix[last_match_row][last_match_col]
+          transposition += row - last_match_row - 1
+          transposition += col - last_match_col - 1
+
+          # TODO: do insertion/deletion need to be considered when
+          # seq1_item == seq2_item ?
+          deletion = matrix[row][col + 1] + 1
+          insertion = matrix[row + 1][col] + 1
+          substitution = matrix[row][col] + sub_cost
+
+          # step cost is min of operation costs
+          cost = substitution < insertion ? substitution : insertion
+          cost = deletion if deletion < cost
+          cost = transposition if transposition < cost
+
+          matrix[row + 1][col + 1] = cost
+
+          last_match_col = col if sub_cost.zero?
+        end
+
+        item_history[seq1_item] = row
+      end
+
+      matrix[rows + 1][cols + 1]
+    end
+  end
+end

data/lib/edits/hamming.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Edits
+  # @see https://en.wikipedia.org/wiki/Hamming_distance
+  module Hamming
+    # Calculate the Hamming distance between two sequences.
+    #
+    # @note A true distance metric, satisfies triangle inequality.
+    #
+    # @param seq1 [String, Array]
+    # @param seq2 [String, Array]
+    # @return [Integer] Hamming distance
+    def self.distance(seq1, seq2)
+      # if seq1.is_a?(Integer) && seq2.is_a?(Integer)
+      #   return (seq1 ^ seq2).to_s(2).count("1")
+      # end
+
+      length = seq1.length < seq2.length ? seq1.length : seq2.length
+      diff = (seq1.length - seq2.length).abs
+
+      length.times.reduce(diff) do |distance, i|
+        seq1[i] == seq2[i] ? distance : distance + 1
+      end
+    end
+  end
+end

data/lib/edits/jaro.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Edits
+  # @see https://en.wikipedia.org/wiki/Jaro-Winkler_distance
+  module Jaro
+    # Calculate Jaro similarity
+    #
+    # `Sj = 1/3 * ((m / |A|) + (m / |B|) + ((m - t) / m))`
+    #
+    # Where `m` is #matches and `t` is #transposes
+    #
+    # @example
+    #   Edits::Jaro.similarity("information", "informant")
+    #   # => 0.9023569023569024
+    # @param seq1 [String, Array]
+    # @param seq2 [String, Array]
+    # @return [Float]
+    def self.similarity(seq1, seq2)
+      return 1.0 if seq1 == seq2
+      return 0.0 if seq1.empty? || seq2.empty?
+
+      seq1 = seq1.codepoints if seq1.is_a? String
+      seq2 = seq2.codepoints if seq2.is_a? String
+
+      m, t = jaro_matches(seq1, seq2)
+      return 0.0 if m.zero?
+
+      m = m.to_f
+      (1.0 / 3) * ((m / seq1.length) + (m / seq2.length) + ((m - t) / m))
+    end
+
+    # Calculate Jaro distance
+    #
+    # @example
+    #   Edits::Jaro.distance("information", "informant")
+    #   # => 0.09764309764309764
+    # @param (see #distance)
+    # @return [Float]
+    def self.distance(str1, str2)
+      1.0 - similarity(str1, str2)
+    end
+
+    # Calculate number of Jaro matches and transpositions
+    #
+    # @param (see #distance)
+    # @return [(Integer, Integer)] matches and transpositions
+    def self.jaro_matches(seq1, seq2)
+      if seq1.length > seq2.length
+        temp = seq1
+        seq1 = seq2
+        seq2 = temp
+      end
+
+      # search range: (max(|A|, |B|) / 2) - 1
+      range = (seq2.length / 2) - 1
+      range = 0 if range.negative?
+
+      seq1_flags = Array.new(seq1.length, false)
+      seq2_flags = Array.new(seq2.length, false)
+
+      matches = 0
+      last2 = seq2.length - 1
+
+      # Pass 1:
+      # - determine number of matches
+      # - initialize transposition flags
+      seq1.length.times do |i|
+        min_bound = i >= range ? i - range : 0
+        max_bound = (i + range) <= last2 ? (i + range) : last2
+
+        min_bound.upto(max_bound) do |j|
+          next unless seq2_flags[j] != true && seq2[j] == seq1[i]
+
+          seq2_flags[j] = true
+          seq1_flags[i] = true
+          matches += 1
+          break
+        end
+      end
+
+      return [0, 0] if matches.zero?
+
+      transposes = 0
+      j = 0
+
+      # Pass 2: determine number of half-transpositions
+      seq1.length.times do |i|
+        # find a match in first string
+        next unless seq1_flags[i] == true
+        # go to location of next match on second string
+        j += 1 until seq2_flags[j]
+
+        # transposition if not the current match
+        transposes += 1 if seq1[i] != seq2[j]
+        j += 1
+      end
+
+      # half-transpositions -> transpositions
+      transposes /= 2
+
+      [matches, transposes]
+    end
+    private_class_method :jaro_matches
+  end
+end

data/lib/edits/jaro_winkler.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Edits
+  # @see https://en.wikipedia.org/wiki/Jaro-Winkler_distance
+  module JaroWinkler
+    # Prefix scaling factor for jaro-winkler metric. Default is 0.1
+    # Should not exceed 0.25 or metric range will leave 0..1
+    WINKLER_PREFIX_WEIGHT = 0.1
+
+    # Threshold for boosting Jaro with winkler prefix multiplier.
+    # Default is 0.7
+    WINKLER_THRESHOLD = 0.7
+
+    # Calculate Jaro-Winkler similarity of given strings
+    #
+    # Adds weight to Jaro distance according to the length of a common prefix
+    # of up to 4 letters, where exists. The additional weighting is only
+    # applied when the original distance passes a threshold.
+    #
+    # `Sw = Sj + (l * p * (1 - Dj))`
+    #
+    # Where `Sj` is Jaro, `l` is prefix length, and `p` is prefix weight
+    #
+    # @example
+    #   Edits::JaroWinkler.similarity("information", "informant")
+    #   # => 0.9414141414141414
+    #
+    # @param seq1 [String, Array]
+    # @param seq2 [String, Array]
+    # @param threshold [Float] threshold for applying Winkler prefix weighting
+    # @param weight [Float] weighting for common prefix, should not exceed 0.25
+    # @return [Float]
+    def self.similarity(
+      seq1, seq2,
+      threshold: WINKLER_THRESHOLD,
+      weight: WINKLER_PREFIX_WEIGHT
+    )
+
+      dj = Jaro.similarity(seq1, seq2)
+
+      if dj > threshold
+        # size of common prefix, max 4
+        max_bound = seq1.length > seq2.length ? seq2.length : seq1.length
+        max_bound = 4 if max_bound > 4
+
+        l = 0
+        l += 1 until seq1[l] != seq2[l] || l >= max_bound
+
+        l < 1 ? dj : dj + (l * weight * (1 - dj))
+      else
+        dj
+      end
+    end
+
+    # Calculate Jaro-Winkler distance
+    #
+    # @note Not a true distance metric, fails to satisfy triangle inequality.
+    #
+    # @example
+    #   Edits::JaroWinkler.distance("information", "informant")
+    #   # => 0.05858585858585863
+    # @param (see #distance)
+    # @return [Float]
+    def self.distance(
+      seq1, seq2,
+      threshold: WINKLER_THRESHOLD,
+      weight: WINKLER_PREFIX_WEIGHT
+    )
+      1.0 - similarity(seq1, seq2, threshold: threshold, weight: weight)
+    end
+  end
+end

data/lib/edits/levenshtein.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Edits
+  # Implementation of Levenshtein distance algorithm.
+  #
+  # Determines distance between two string by counting edits, identifying:
+  # - Insertion
+  # - Deletion
+  # - Substitution
+  module Levenshtein
+    # Calculate the Levenshtein (edit) distance of two sequences.
+    #
+    # @note A true distance metric, satisfies triangle inequality.
+    # @example
+    #   Levenshtein.distance('sand', 'hands')
+    #   # => 2
+    # @param seq1 [String, Array]
+    # @param seq2 [String, Array]
+    # @return [Integer]
+    def self.distance(seq1, seq2)
+      if seq1.length > seq2.length
+        temp = seq1
+        seq1 = seq2
+        seq2 = temp
+      end
+
+      # array of Integer codepoints outperforms String
+      seq1 = seq1.codepoints if seq1.is_a? String
+      seq2 = seq2.codepoints if seq2.is_a? String
+
+      rows = seq1.length
+      cols = seq2.length
+      return cols if rows.zero?
+      return rows if cols.zero?
+
+      # Initialize first row of cost matrix.
+      # The full initial state where cols=3, rows=2 would be:
+      #   [[0, 1, 2, 3],
+      #    [1, 0, 0, 0],
+      #    [2, 0, 0, 0]]
+      last_row = 0.upto(cols).to_a
+
+      rows.times do |row|
+        last_col = row + 1
+
+        seq1_item = seq1[row]
+
+        cols.times do |col|
+          deletion = last_row[col + 1] + 1
+          insertion = last_col + 1
+          substitution = last_row[col] + (seq1_item == seq2[col] ? 0 : 1)
+
+          # step cost is min of operation costs
+          cost = deletion < insertion ? deletion : insertion
+          cost = substitution if substitution < cost
+
+          # overwrite previous row as we progress
+          last_row[col] = last_col
+          last_col = cost
+        end
+        last_row[cols] = last_col
+      end
+
+      last_row[cols]
+    end
+
+    # Calculate the Levenshtein (edit) distance of two sequences, bounded by
+    # a maximum value.
+    #
+    # @example
+    #   Edits::Levenshtein.distance("cloud", "crayon")
+    #   # => 5
+    #   Edits::Levenshtein.distance_with_max("cloud", "crayon", 2)
+    #   # => 2
+    # @param seq1 [String, Array]
+    # @param seq2 [String, Array]
+    # @param max [Integer] maximum distance
+    # @return [Integer]
+    def self.distance_with_max(seq1, seq2, max)
+      if seq1.length > seq2.length
+        temp = seq1
+        seq1 = seq2
+        seq2 = temp
+      end
+
+      rows = seq1.length
+      cols = seq2.length
+      return cols if rows.zero?
+      return rows if cols.zero?
+      return max if (rows - cols).abs >= max
+
+      seq1 = seq1.codepoints if seq1.is_a? String
+      seq2 = seq2.codepoints if seq2.is_a? String
+
+      last_row = 0.upto(cols).to_a
+
+      rows.times do |row|
+        last_col_cost = row + 1
+        seq1_item = seq1[row]
+
+        min_col = row > max ? row - max : 0
+        max_col = row + max
+        max_col = cols - 1 if max_col > cols - 1
+        diagonal = cols - rows + row
+
+        cols.times do |col|
+          return max if diagonal == col && last_row[col] >= max
+          col_cost =
+            if col < min_col || col > max_col
+              max + 1
+            else
+              # step cost is min of operation costs
+              deletion = last_row[col + 1] + 1
+              insertion = last_col_cost + 1
+              substitution = last_row[col] + (seq1_item == seq2[col] ? 0 : 1)
+
+              cost = deletion < insertion ? deletion : insertion
+              substitution < cost ? substitution : cost
+            end
+
+          last_row[col] = last_col_cost
+          last_col_cost = col_cost
+        end
+
+        last_row[cols] = last_col_cost
+      end
+
+      last_row[cols] > max ? max : last_row[cols]
+    end
+
+    # Given a prototype string and an array of strings, determines which
+    # string is most similar to the prototype.
+    #
+    # `Levenshtein.most_similar("foo", strings)` is functionally equivalent to
+    # `strings.min_by { |s| Levenshtein.distance("foo", s) }`, leveraging
+    # {.distance_with_max}.
+    #
+    # @example
+    #   Edits::Levenshtein.most_similar("atom", %w[tram atlas rota racer])
+    #   # => "atlas"
+    # @param prototype [String]
+    # @param strings [<String>]
+    # @return [String, nil] most similar string, or nil for empty array
+    def self.most_similar(prototype, strings)
+      return nil if strings.empty?
+      min_s = strings[0]
+      min_d = distance(prototype, min_s)
+
+      strings[1..-1].each do |s|
+        return min_s if min_d.zero?
+        d = distance_with_max(prototype, s, min_d)
+        if d < min_d
+          min_d = d
+          min_s = s
+        end
+      end
+
+      min_s
+    end
+  end
+end

data/lib/edits/restricted_edit.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Edits
+  # Implements Restricted Damerau-Levenshtein distance (Optimal Alignment)
+  # algorithm.
+  #
+  # Determines distance between two strings by counting edits, identifying:
+  # * Insertion
+  # * Deletion
+  # * Substitution
+  # * Swapped items
+  module RestrictedEdit
+    # Calculate the Restricted Damerau-Levenshtein distance (Optimal Alignment)
+    # of two sequences.
+    #
+    # @note Not a true distance metric, fails to satisfy triangle inequality.
+    # @example
+    #   RestrictedEdit.distance("iota", "atom")
+    #   # => 3
+    # @param seq1 [String, Array]
+    # @param seq2 [String, Array]
+    # @return [Integer]
+    def self.distance(seq1, seq2)
+      if seq1.length > seq2.length
+        temp = seq1
+        seq1 = seq2
+        seq2 = temp
+      end
+
+      # array of Integer codepoints outperforms String
+      seq1 = seq1.codepoints if seq1.is_a? String
+      seq2 = seq2.codepoints if seq2.is_a? String
+
+      rows = seq1.length
+      cols = seq2.length
+      return cols if rows.zero?
+      return rows if cols.zero?
+
+      # previous two rows of cost matrix are retained
+      lastlast_row = []
+      last_row = []
+      # Initialize first row of cost matrix.
+      # The full initial state where cols=3, rows=2 would be:
+      #   [[0, 1, 2, 3],
+      #    [1, 0, 0, 0],
+      #    [2, 0, 0, 0]]
+      curr_row = 0.upto(cols).to_a
+
+      rows.times do |row|
+        lastlast_row = last_row
+        last_row = curr_row
+
+        # generate next row of cost matrix
+        curr_row = Array.new(cols + 1, 0)
+        curr_row[0] = row + 1
+
+        curr_item = seq1[row]
+
+        cols.times do |col|
+          sub_cost = curr_item == seq2[col] ? 0 : 1
+          is_swap = sub_cost == 1 &&
+            row.positive? && col.positive? &&
+            curr_item == seq2[col - 1] &&
+            seq1[row - 1] == seq2[col]
+
+          deletion = last_row[col + 1] + 1
+          insertion = curr_row[col] + 1
+          substitution = last_row[col] + sub_cost
+
+          # step cost is min of operation costs
+          cost = deletion < insertion ? deletion : insertion
+          cost = substitution if substitution < cost
+
+          if is_swap
+            swap = lastlast_row[col - 1] + 1
+            cost = swap if swap < cost
+          end
+
+          curr_row[col + 1] = cost
+        end
+      end
+
+      curr_row[cols]
+    end
+  end
+end

data/lib/edits/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Edits
+  VERSION = "0.1.0"
+end

data/tasks/benchmark.rake

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "benchmark"
+require "edits"
+
+desc "Compare metrics"
+task :benchmark do
+  words = File.read("/usr/share/dict/words")
+    .split(/\n/).compact.shuffle(random: Random.new(1))
+
+  Benchmark.bm(20) do |x|
+    x.report("Hamming") do
+      words.each_cons(2) do |a, b|
+        Edits::Hamming.distance a, b
+      end
+    end
+
+    x.report("Levenshtein") do
+      words.each_cons(2) do |a, b|
+        Edits::Levenshtein.distance a, b
+      end
+    end
+
+    x.report("RestrictedEdit") do
+      words.each_cons(2) do |a, b|
+        Edits::RestrictedEdit.distance a, b
+      end
+    end
+
+    x.report("DamerauLevenshtein") do
+      words.each_cons(2) do |a, b|
+        Edits::DamerauLevenshtein.distance a, b
+      end
+    end
+
+    x.report("Jaro") do
+      words.each_cons(2) do |a, b|
+        Edits::Jaro.distance a, b
+      end
+    end
+
+    x.report("JaroWinkler") do
+      words.each_cons(2) do |a, b|
+        Edits::JaroWinkler.distance a, b
+      end
+    end
+  end
+end

data/tasks/benchmark/levenshtein.rake

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "benchmark"
+require "benchmark/ips"
+require "edits"
+
+namespace :benchmark do
+  desc "distance vs. distance_with_max (x100)"
+  task :lev_max do
+    words = File.read("/usr/share/dict/words")
+      .split(/\n/).compact.shuffle(random: Random.new(1))
+      .take(101)
+
+    Benchmark.ips do |x|
+      x.report("distance") do
+        words.each_cons(2) do |a, b|
+          Edits::Levenshtein.distance a, b
+        end
+      end
+
+      x.report("with max 1") do
+        words.each_cons(2) do |a, b|
+          Edits::Levenshtein.distance_with_max a, b, 1
+        end
+      end
+
+      x.report("with max 2") do
+        words.each_cons(2) do |a, b|
+          Edits::Levenshtein.distance_with_max a, b, 2
+        end
+      end
+
+      x.report("with max 3") do
+        words.each_cons(2) do |a, b|
+          Edits::Levenshtein.distance_with_max a, b, 3
+        end
+      end
+
+      x.report("with max 4") do
+        words.each_cons(2) do |a, b|
+          Edits::Levenshtein.distance_with_max a, b, 4
+        end
+      end
+
+      x.report("with max 6") do
+        words.each_cons(2) do |a, b|
+          Edits::Levenshtein.distance_with_max a, b, 6
+        end
+      end
+
+      x.report("with max 8") do
+        words.each_cons(2) do |a, b|
+          Edits::Levenshtein.distance_with_max a, b, 8
+        end
+      end
+
+      x.report("with max 50") do
+        words.each_cons(2) do |a, b|
+          Edits::Levenshtein.distance_with_max a, b, 100
+        end
+      end
+
+      x.compare!
+    end
+  end
+
+  desc "most_similar vs. min_by (100 words)"
+  task :lev_similar do
+    words = File.read("/usr/share/dict/words")
+      .split(/\n/).compact.shuffle(random: Random.new(1))
+      .take(100)
+
+    Benchmark.ips do |x|
+      x.report("most_similar") do
+        Edits::Levenshtein.most_similar("wxyz", words)
+      end
+
+      x.report("min_by") do
+        words.min_by { |s| Edits::Levenshtein.distance("wxyz", s) }
+      end
+
+      x.compare!
+    end
+  end
+
+  task :rowgen1 do
+    cols = 5
+    rows = 3
+
+    Benchmark.ips do |x|
+      x.report "new, unshift" do
+        Array.new(cols, 0).unshift(rows)
+      end
+
+      x.report "new, []=" do
+        curr_row = Array.new(cols + 1, 0)
+        curr_row[0] = rows
+      end
+
+      x.report "literal, concat" do
+        [rows].concat(Array.new(cols, 0))
+      end
+
+      x.report "literal, +" do
+        m = []
+        m << [rows] + Array.new(cols, 0)
+      end
+
+      x.compare!
+    end
+  end
+
+  task :rowgen2 do
+    cols = 5
+    rows = 3
+    inf = cols + rows
+
+    Benchmark.ips do |x|
+      x.report "new, unshift" do
+        m = []
+        m << Array.new(cols, 0).unshift(rows, inf)
+      end
+
+      x.report "new, []=" do
+        m = []
+        curr_row = Array.new(cols + 2, 0)
+        curr_row[0] = rows
+        curr_row[1] = inf
+        m << curr_row
+      end
+
+      x.report "literal, concat" do
+        m = []
+        m << [rows, inf].concat(Array.new(cols, 0))
+      end
+
+      x.report "literal, +" do
+        m = []
+        m << [rows, inf] + Array.new(cols, 0)
+      end
+
+      x.compare!
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: edits
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Crouch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- tom.crouch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- edits.gemspec
+- lib/edits.rb
+- lib/edits/damerau_levenshtein.rb
+- lib/edits/hamming.rb
+- lib/edits/jaro.rb
+- lib/edits/jaro_winkler.rb
+- lib/edits/levenshtein.rb
+- lib/edits/restricted_edit.rb
+- lib/edits/version.rb
+- tasks/benchmark.rake
+- tasks/benchmark/levenshtein.rake
+homepage: https://github.com/tcrouch/edits
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A collection of edit distance algorithms.
+test_files: []