Enum DistanceMetric 

#[non_exhaustive]
pub enum DistanceMetric {
    Cosine,
    L2,
    Dot,
}

Variants (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.

Cosine

L2

Dot

Implementations

impl DistanceMetric

pub fn compute_distance(&self, a: &[f32], b: &[f32]) -> f32

Computes the distance between two vectors using this metric.

All metrics follow LanceDB conventions so that lower values indicate greater similarity:

• L2: squared Euclidean distance.
• Cosine: 1.0 - cosine_similarity (range [0, 2]).
• Dot: negative dot product.

Panics

Panics if a and b have different lengths.

Trait Implementations

impl Clone for DistanceMetric

fn clone(&self) -> DistanceMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DistanceMetric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DistanceMetric

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DistanceMetric

fn eq(&self, other: &DistanceMetric) -> 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 Serialize for DistanceMetric

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DistanceMetric