Struct rust2vec::similarity::WordSimilarity

pub struct WordSimilarity<'a> {
    pub similarity: NotNan<f32>,
    pub word: &'a str,
}

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.

Fields

similarity: NotNan<f32>

word: &'a str

Trait Implementations

impl<'a> PartialOrd<WordSimilarity<'a>> for WordSimilarity<'a>

fn partial_cmp(&self, other: &WordSimilarity) -> 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> PartialEq<WordSimilarity<'a>> for WordSimilarity<'a>

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

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

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

This method tests for !=.

impl<'a> Ord for WordSimilarity<'a>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl<'a> Eq for WordSimilarity<'a>

impl<'a> Debug for WordSimilarity<'a>

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

Formats the value using the given formatter.