Struct finalfusion::similarity::WordSimilarityResult

pub struct WordSimilarityResult<'a> { /* fields omitted */ }

A word with its similarity.

This data structure is used to store a pair consisting of a word and its similarity to a query word.

Implementations

impl<'a> WordSimilarityResult<'a>

pub fn angular_similarity(&self) -> f32

Get the word's similarity in angular similarity.

pub fn cosine_similarity(&self) -> f32

Get the word's similarity in cosine similarity.

pub fn euclidean_distance(&self) -> f32

Get the euclidean distance between the vectors.

pub fn euclidean_similarity(&self) -> f32

Returns the euclidean similarity.

This method returns a similarity in [0,1], where 0 corresponds to a euclidean distance of 2 (the maximum distance between two unit vectors) and 1 to a euclidean distance of 0.

pub fn word(&self) -> &str

Trait Implementations

impl<'a> Debug for WordSimilarityResult<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for WordSimilarityResult<'a>

impl<'a> Ord for WordSimilarityResult<'a>

fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> PartialEq<WordSimilarityResult<'a>> for WordSimilarityResult<'a>

fn eq(&self, other: &WordSimilarityResult<'a>) -> bool

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

fn ne(&self, other: &WordSimilarityResult<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<WordSimilarityResult<'a>> for WordSimilarityResult<'a>

fn partial_cmp(&self, other: &WordSimilarityResult<'_>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> StructuralEq for WordSimilarityResult<'a>

impl<'a> StructuralPartialEq for WordSimilarityResult<'a>