[−][src]Crate eddie

Fast and well-tested implementations of edit distance/string similarity metrics:

Installation

Add this to your Cargo.toml:

[dependencies]
eddie = "0.4"

Levenshtein:

use eddie::Levenshtein;
let lev = Levenshtein::new();
let dist = lev.distance("martha", "marhta");
assert_eq!(dist, 2);

Damerau-Levenshtein:

use eddie::DamerauLevenshtein;
let damlev = DamerauLevenshtein::new();
let dist = damlev.distance("martha", "marhta");
assert_eq!(dist, 1);

Hamming:

use eddie::Hamming;
let hamming = Hamming::new();
let dist = hamming.distance("martha", "marhta");
assert_eq!(dist, Some(2));

Jaro:

use eddie::Jaro;
let jaro = Jaro::new();
let sim = jaro.similarity("martha", "marhta");
assert!((sim - 0.94).abs() < 0.01);

Jaro-Winkler:

use eddie::JaroWinkler;
let jarwin = JaroWinkler::new();
let sim = jarwin.similarity("martha", "marhta");
assert!((sim - 0.96).abs() < 0.01);

The main metric methods are complemented with inverted and/or relative versions. The naming convention across the crate is following:

distance — a number of edits required to transform one string to the other;
rel_dist — a distance between two strings, relative to string length (inversion of similarity);
similarity — similarity between two strings (inversion of relative distance).

The crate exposes two modules containing two sets of implementations:

eddie::str for comparing UTF-8 encoded &str and &String values. Implementations are reexported in the root module.
eddie::slice for comparing generic slices &[T]. Implementations in this module are significantly faster than those from eddie::str, but will produce incorrect results for UTF-8 and other variable width character encodings.

Usage example:

use eddie::slice::Levenshtein;

let lev = Levenshtein::new();
let dist = lev.distance(&[1, 2, 3, 4], &[1, 3, 2, 4]);
assert_eq!(dist, 2);

At the moment Eddie has the fastest implementations among the alternatives from crates.io that have Unicode support.

For example, when comparing common english words you can expect at least 1.5-2x speedup for any given algorithm except Hamming.

For the detailed measurements tables see Benchmarks page.

slice	Distance/similarity metric implementations for generic slices `&[T]`.
str	Distance/similarity metric implementations for UTF-8 encoded `&str` and `&String` values.

DamerauLevenshtein	Damerau-Levenshtein distance.
Hamming	Hamming distance.
Jaro	Jaro similarity.
JaroWinkler	Jaro-Winkler similarity.
Levenshtein	Levenshtein distance.