Struct eddie::Jaro

pub struct Jaro { /* fields omitted */ }

Jaro similarity.

See the detailed description.

Usage

use eddie::Jaro;

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

Complementary metrics

Relative distance:

let sim = jaro.similarity(s1, s2);
let dist = jaro.rel_dist(s1, s2);
assert_eq!(dist, 1.0 - sim);

Methods

impl Jaro

pub fn new() -> Self

Creates a new instance of Jaro struct with an internal state for the metric methods to reuse.

Example

use eddie::Jaro;

let jaro = Jaro::new();

pub fn similarity(&self, str1: &str, str2: &str) -> f64

Similarity metric. Reflects how close two strings are, ranging from 1.0 (equality) to 0.0 (nothing in common).

Example

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

pub fn rel_dist(&self, str1: &str, str2: &str) -> f64

Relative distance metric. Inversion of similarity. Reflects how far apart two strings are, ranging from 0.0 (equality) to 1.0 (nothing in common).

Example

let dist = jaro.rel_dist("martha", "marhta");
assert!((dist - 0.06).abs() < 0.01);