Struct space::Hamming

pub struct Hamming<T>(pub T);

Any data contained in this struct is treated such that all of the bits of the data are each separate dimensions that can be of length 0 or 1. This is referred to as hamming space. This leads to all Lp spaces being equal and all distances being no larger than the number of bits of the data.

This is typically used to perform searches on data that was binarized using hyperplane comparisons on high dimensional floating-point features or data built on a series of binary comparisons. Hamming distance is incredibly fast to compute. Hamming space can be difficult to search because the amount of equidistant points is high (see "Thick Boundaries in Binary Space and Their Influence on Nearest-Neighbor Search") and they can quickly grow in dimensionality.

Trait Implementations

impl<T: Clone> Clone for Hamming<T>

fn clone(&self) -> Hamming<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Hamming<T>

impl<T: Debug> Debug for Hamming<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Hamming<T>

impl<T: Hash> Hash for Hamming<T>

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 MetricPoint for Hamming<u8>

fn distance(&self, rhs: &Self) -> u32

impl MetricPoint for Hamming<u16>

fn distance(&self, rhs: &Self) -> u32

impl MetricPoint for Hamming<u32>

fn distance(&self, rhs: &Self) -> u32

impl MetricPoint for Hamming<u64>

fn distance(&self, rhs: &Self) -> u32

impl MetricPoint for Hamming<u128>

fn distance(&self, rhs: &Self) -> u32

impl<T: PartialEq> PartialEq<Hamming<T>> for Hamming<T>

fn eq(&self, other: &Hamming<T>) -> bool

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

fn ne(&self, other: &Hamming<T>) -> bool

This method tests for !=.

impl<T> StructuralEq for Hamming<T>

impl<T> StructuralPartialEq for Hamming<T>