Struct space::Neighbor

pub struct Neighbor {
    pub index: usize,
    pub distance: u32,
}

For k-NN algorithms to return neighbors.

Fields

index: usize

Index of the neighbor in the search space.

distance: u32

The distance of the neighbor from the search feature.

Methods

impl Neighbor

pub fn invalid() -> Self

Generates an invalid (on purpose) neighbor to initialize an array.

Generated neighbor has maximum index and distance. This is to ensure that software does not silently fail as an out-of-bounds will occur if an invalid neighbor is used.

Trait Implementations

impl Clone for Neighbor

fn clone(&self) -> Neighbor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Neighbor

impl Debug for Neighbor

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

Formats the value using the given formatter.

impl Eq for Neighbor

impl Hash for Neighbor

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 Ord for Neighbor

fn cmp(&self, other: &Neighbor) -> 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 PartialEq<Neighbor> for Neighbor

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

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

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

This method tests for !=.

impl PartialOrd<Neighbor> for Neighbor

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Neighbor

impl StructuralPartialEq for Neighbor