#levenshtein #string-similarity #hamming #similarity #jaro #string

strsim

Implementations of string similarity metrics. Includes Hamming, Levenshtein, OSA, Damerau-Levenshtein, Jaro, Jaro-Winkler, and Sørensen-Dice.

23 releases

Uses old Rust 2015

0.11.0 Jan 7, 2024
0.10.0 Jan 31, 2020
0.9.3 Dec 13, 2019
0.9.2 May 9, 2019
0.2.2 Mar 29, 2015

#4 in Algorithms

Download history 1568365/week @ 2023-11-27 1592092/week @ 2023-12-04 1622525/week @ 2023-12-11 1460501/week @ 2023-12-18 856668/week @ 2023-12-25 1373253/week @ 2024-01-01 1712286/week @ 2024-01-08 1741929/week @ 2024-01-15 1770831/week @ 2024-01-22 1964228/week @ 2024-01-29 1946879/week @ 2024-02-05 2108138/week @ 2024-02-12 2118887/week @ 2024-02-19 2295732/week @ 2024-02-26 2312121/week @ 2024-03-04 888305/week @ 2024-03-11

7,751,717 downloads per month
Used in 1,617 crates (487 directly)

MIT license

43KB
965 lines

strsim-rs

Crates.io Crates.io CI status unsafe forbidden

Rust implementations of string similarity metrics:

The normalized versions return values between 0.0 and 1.0, where 1.0 means an exact match.

There are also generic versions of the functions for non-string inputs.

Installation

strsim is available on crates.io. Add it to your project:

cargo add strsim

Usage

Go to Docs.rs for the full documentation. You can also clone the repo, and run $ cargo doc --open.

Examples

extern crate strsim;

use strsim::{hamming, levenshtein, normalized_levenshtein, osa_distance,
             damerau_levenshtein, normalized_damerau_levenshtein, jaro,
             jaro_winkler, sorensen_dice};

fn main() {
    match hamming("hamming", "hammers") {
        Ok(distance) => assert_eq!(3, distance),
        Err(why) => panic!("{:?}", why)
    }

    assert_eq!(levenshtein("kitten", "sitting"), 3);

    assert!((normalized_levenshtein("kitten", "sitting") - 0.571).abs() < 0.001);

    assert_eq!(osa_distance("ac", "cba"), 3);

    assert_eq!(damerau_levenshtein("ac", "cba"), 2);

    assert!((normalized_damerau_levenshtein("levenshtein", "löwenbräu") - 0.272).abs() <
            0.001);

    assert!((jaro("Friedrich Nietzsche", "Jean-Paul Sartre") - 0.392).abs() <
            0.001);

    assert!((jaro_winkler("cheeseburger", "cheese fries") - 0.911).abs() <
            0.001);

    assert_eq!(sorensen_dice("web applications", "applications of the web"),
        0.7878787878787878);
}

Using the generic versions of the functions:

extern crate strsim;

use strsim::generic_levenshtein;

fn main() {
    assert_eq!(2, generic_levenshtein(&[1, 2, 3], &[0, 2, 5]));
}

Contributing

If you don't want to install Rust itself, you can run $ ./dev for a development CLI if you have Docker installed.

Benchmarks require a Nightly toolchain. Run $ cargo +nightly bench.

License

MIT

No runtime deps