Enum Metric 

#[repr(u8)]
pub enum Metric {
    L2 = 0,
    Cosine = 1,
    Dot = 2,
}

Distance metric for similarity search (user-facing API type).

This is the serialization/API type stored in .omen file headers. For runtime distance computation, see crate::vector::hnsw::DistanceFunction.

Variants

L2 = 0

L2 / Euclidean distance

Cosine = 1

Cosine distance (1 - cosine similarity)

Dot = 2

Dot product / inner product (for MIPS)

Implementations

impl Metric

pub fn parse(s: &str) -> Result<Self, String>

Parse from string (case-insensitive, with aliases).

Supported values

• "l2" or "euclidean": Euclidean distance (default)
• "cosine": Cosine distance (1 - cosine similarity)
• "dot" or "ip": Inner product (for MIPS)

pub fn as_str(&self) -> &'static str

Get the string representation.

Trait Implementations

impl Clone for Metric

fn clone(&self) -> Metric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metric

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

Formats the value using the given formatter.

impl From<DistanceFunction> for Metric

fn from(d: DistanceFunction) -> Self

Converts to this type from the input type.

impl From<Metric> for DistanceFunction

fn from(m: Metric) -> Self

Converts to this type from the input type.

impl From<u8> for Metric

fn from(v: u8) -> Self

Converts to this type from the input type.

impl PartialEq for Metric

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

impl Eq for Metric

impl StructuralPartialEq for Metric