Struct str_distance::modifiers::Winkler

pub struct Winkler<D: DistanceMetric> { /* fields omitted */ }

Winkler modifies a DistanceMetric's distance to decrease the distance between two strings, when their original distance is below some threshold. The boost is equal to min(l, maxlength) * p * dist where l denotes the length of their common prefix and dist denotes the original distance. The Winkler adjustment was originally defined for the Jaro similarity score but is here defined it for any distance.

Methods

impl<D: DistanceMetric> Winkler<D>

pub fn new(inner: D) -> Self

pub fn with_config(inner: D, config: WinklerConfig) -> Self

Trait Implementations

impl<D: Clone + DistanceMetric> Clone for Winkler<D>

fn clone(&self) -> Winkler<D>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D: Debug + DistanceMetric> Debug for Winkler<D>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Winkler<Jaro>

fn default() -> Self

Returns the "default value" for a type.

impl<D> DistanceMetric for Winkler<D> where
    D: DistanceMetric,
    <D as DistanceMetric>::Dist: Into<f64>, 

type Dist = f64

Represents the data type in which this distance is evaluated.

fn distance<S, T>(&self, a: S, b: T) -> Self::Dist where
    S: IntoIterator,
    T: IntoIterator,
    <S as IntoIterator>::IntoIter: Clone,
    <T as IntoIterator>::IntoIter: Clone,
    <S as IntoIterator>::Item: PartialEq + PartialEq<<T as IntoIterator>::Item>,
    <T as IntoIterator>::Item: PartialEq, 

Generic implementation of the metric.

fn str_distance<S, T>(&self, s1: S, s2: T) -> Self::Dist where
    S: AsRef<str>,
    T: AsRef<str>, 

Evaluates the distance between two str.

fn normalized<S, T>(&self, a: S, b: T) -> f64 where
    S: IntoIterator,
    T: IntoIterator,
    <S as IntoIterator>::IntoIter: Clone,
    <T as IntoIterator>::IntoIter: Clone,
    <S as IntoIterator>::Item: PartialEq + PartialEq<<T as IntoIterator>::Item>,
    <T as IntoIterator>::Item: PartialEq, 

Evaluates the normalized distance between two strings A value of '0.0' corresponds to the "zero distance", both strings are considered equal by means of the metric, whereas a value of '1.0' corresponds to the maximum distance that can exist between the strings.

fn str_normalized<S, T>(&self, a: S, b: T) -> f64 where
    S: AsRef<str>,
    T: AsRef<str>, 

Convenience normalization for str types.