Enum imdb_index::Similarity

pub enum Similarity {
    None,
    Levenshtein,
    Jaro,
    JaroWinkler,
}

A ranking function to use when searching IMDb records.

A similarity ranking function computes a score between 0.0 and 1.0 (not including 0 but including 1.0) for a query and a candidate result. The score is determined by the corresponding names for a query and a candidate, and a higher score indicates more similarity.

This ranking function can be used to increase the precision of a set of results. In particular, when a similarity function is provided to a Query, then any results returned by querying the IMDb name index will be rescored according to this function. If no similarity function is provided, then the results will be ranked according to scores produced by the name index.

Variants

None

Do not use a similarity function.

Levenshtein

Computes the Levenshtein edit distance between two names and converts it to a similarity.

Jaro

Computes the Jaro edit distance between two names and converts it to a similarity.

JaroWinkler

Computes the Jaro-Winkler edit distance between two names and converts it to a similarity.

Methods

impl Similarity

pub fn possible_names() -> &'static [&'static str]

Returns a list of s trings representing the possible similarity function names.

pub fn is_none(&self) -> bool

Returns true if and only if no similarity function was selected.

pub fn similarity(&self, q1: &str, q2: &str) -> f64

Computes the similarity between the given strings according to the underlying similarity function. If no similarity function is present, then this always returns 1.0.

The returned value is always in the range (0, 1].

Trait Implementations

impl PartialEq<Similarity> for Similarity

fn eq(&self, other: &Similarity) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for Similarity

impl Eq for Similarity

impl Default for Similarity

fn default() -> Similarity

Returns the "default value" for a type.

impl Clone for Similarity

fn clone(&self) -> Similarity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for Similarity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for Similarity

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

Formats the value using the given formatter.

impl Display for Similarity

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

Formats the value using the given formatter.

impl FromStr for Similarity

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Similarity>

Parses a string s to return a value of this type.