Struct Neighbor

pub struct Neighbor<'t, T: 't> {
    pub item: &'t T,
    pub dist: u64,
}

Wrapper of an item and a distance, returned by Neighbors.

Fields

item: &'t T

The item that this entry concerns.

dist: u64

The distance between item and the origin passed to VpTree::k_nearest().

Trait Implementations

impl<'t, T: Clone + 't> Clone for Neighbor<'t, T>

fn clone(&self) -> Neighbor<'t, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'t, T: Debug + 't> Debug for Neighbor<'t, T>

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

Formats the value using the given formatter.

impl<'t, T: 't> Ord for Neighbor<'t, T>

Returns the comparison of the distances only.

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<'t, T: 't> PartialEq for Neighbor<'t, T>

Returns the equality of the distances only.

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'t, T: 't> PartialOrd for Neighbor<'t, T>

Returns the comparison of the distances only.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<'t, T: 't> Eq for Neighbor<'t, T>

Returns the equality of the distances only.