Enum DistanceMetric 

pub enum DistanceMetric {
    Cosine,
    DotProduct,
    Euclidean,
}

Distance metric for a vector type. Search always ranks by a higher-is-better score, so Euclidean is surfaced as the negated distance.

Variants

Cosine

DotProduct

Euclidean

Implementations

impl DistanceMetric

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

Higher score == more similar, for any metric. Convenience wrapper that computes the query’s norm inline; prefer DistanceMetric::query_norm + DistanceMetric::score_pre in a scan loop to amortize the query norm.

pub fn query_norm(&self, q: &[f32]) -> f32

Precompute the query-side norm once per query. Only Cosine needs it; the others return 1.0.

pub fn score_pre( &self, query: &[f32], candidate: &[f32], query_norm: f32, ) -> f32

Score candidate against query, reusing a precomputed query_norm. Hoists the query norm out of the per-candidate hot loop.

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 Copy for DistanceMetric

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 Eq for DistanceMetric

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