Skip to main content

DistanceType

Enum DistanceType 

Source
#[non_exhaustive]
pub enum DistanceType {
Show 22 variants L2Expanded, L2SqrtExpanded, CosineExpanded, L1, L2Unexpanded, L2SqrtUnexpanded, InnerProduct, Linf, Canberra, LpUnexpanded(f32), CorrelationExpanded, JaccardExpanded, HellingerExpanded, Haversine, BrayCurtis, JensenShannon, HammingUnexpanded, KLDivergence, RusselRaoExpanded, DiceExpanded, BitwiseHamming, Precomputed,
}
Expand description

Distance metric used for building and searching nearest neighbor indices.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

L2Expanded

L2 (squared Euclidean) distance.

§

L2SqrtExpanded

L2 distance with square root.

§

CosineExpanded

Cosine distance.

§

L1

L1 (Manhattan) distance.

§

L2Unexpanded

L2 distance (unexpanded form).

§

L2SqrtUnexpanded

L2 distance with square root (unexpanded form).

§

InnerProduct

Inner product.

§

Linf

Chebyshev (L-infinity) distance.

§

Canberra

Canberra distance.

§

LpUnexpanded(f32)

Generalized Minkowski (Lp) distance with exponent p.

§

CorrelationExpanded

Correlation distance.

§

JaccardExpanded

Jaccard distance.

§

HellingerExpanded

Hellinger distance.

§

Haversine

Haversine (great-circle) distance.

§

BrayCurtis

Bray-Curtis distance.

§

JensenShannon

Jensen-Shannon divergence.

§

HammingUnexpanded

Hamming distance.

§

KLDivergence

Kullback-Leibler divergence.

§

RusselRaoExpanded

Russell-Rao distance.

§

DiceExpanded

Dice-Sorensen distance.

§

BitwiseHamming

Bitwise Hamming distance.

§

Precomputed

Precomputed distance matrix.

Trait Implementations§

Source§

impl Clone for DistanceType

Source§

fn clone(&self) -> DistanceType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for DistanceType

Source§

impl Debug for DistanceType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<DistanceType> for cuvsDistanceType

Source§

fn from(v: DistanceType) -> Self

Converts to this type from the input type.
Source§

impl From<cuvsDistanceType> for DistanceType

Source§

fn from(v: cuvsDistanceType) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for DistanceType

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DistanceType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.