Struct kiddo::nearest_neighbour::NearestNeighbour

pub struct NearestNeighbour<A, T> {
    pub distance: A,
    pub item: T,
}

Represents an entry in the results of a nearest neighbour query, with distance being the distance of this particular item from the query point, and item being the stored item index that was found as part of the query.

Fields

distance: A

the distance of the found item from the query point according to the supplied distance metric

item: T

the stored index of an item that was found in the query

Trait Implementations

impl<A: Clone, T: Clone> Clone for NearestNeighbour<A, T>

fn clone(&self) -> NearestNeighbour<A, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug, T: Debug> Debug for NearestNeighbour<A, T>

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

Formats the value using the given formatter.

impl<A, T: Content> From<NearestNeighbour<A, T>> for (A, T)

fn from(elem: NearestNeighbour<A, T>) -> Self

Converts to this type from the input type.

impl<A: PartialOrd, T: Content> Ord for NearestNeighbour<A, T>

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 + PartialOrd,

Restrict a value to a certain interval.

impl<A: PartialEq, T: Content> PartialEq for NearestNeighbour<A, T>

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

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

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

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

impl<A: PartialOrd, T: Content> PartialOrd for NearestNeighbour<A, T>

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

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

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

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

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

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

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: Copy, T: Copy> Copy for NearestNeighbour<A, T>

impl<A: PartialEq, T: Content> Eq for NearestNeighbour<A, T>