Enum VectorMetric 

pub enum VectorMetric {
    SquaredEuclidean,
    Cosine,
    NegativeInnerProduct,
}

Distance metric for native dense vectors.

All metrics return a score where lower is better. NegativeInnerProduct is the max-inner-product-search adapter: vectors with larger dot products produce smaller, more favorable scores.

Variants

SquaredEuclidean

Squared Euclidean distance (sum((lhs_i - rhs_i)^2)).

Cosine

Cosine distance (1 - cosine_similarity).

NegativeInnerProduct

Negated dot product (-sum(lhs_i * rhs_i)), lower-is-better MIPS.

Implementations

impl VectorMetric

pub fn bind_query( self, query: &VectorValue, ) -> CoreResult<VectorMetricQuery<'_>>

Bind this metric to one query vector for repeated candidate scoring.

This precomputes metric-specific query state, such as cosine query norm, so exact scans and ANN traversals do not redo invariant work for every candidate.

Errors

VectorMetric::Cosine returns CoreError::VectorZeroNorm when the query has zero magnitude.

pub fn bind_query_with_squared_norm( self, query: &VectorValue, query_squared_norm: f64, ) -> CoreResult<VectorMetricQuery<'_>>

Bind this metric to one query vector with a precomputed query squared norm.

When query_squared_norm is the query’s actual squared norm, this is equivalent to Self::bind_query. It lets ANN indexes cache entry norms for cosine centroid assignment while preserving the canonical metric kernels and error behavior. Non-cosine metrics ignore query_squared_norm.

Errors

VectorMetric::Cosine returns CoreError::VectorZeroNorm when the supplied query squared norm is not positive and finite.

pub fn distance(self, lhs: &VectorValue, rhs: &VectorValue) -> CoreResult<f64>

Compute this metric for two vectors.

Errors

Returns CoreError::VectorDimensionMismatch if dimensions differ. VectorMetric::Cosine also returns CoreError::VectorZeroNorm when either vector has zero magnitude.

Trait Implementations

impl Archive for VectorMetric

type Archived = ArchivedVectorMetric

The archived representation of this type.

type Resolver = VectorMetricResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve( &self, resolver: <Self as Archive>::Resolver, out: Place<<Self as Archive>::Archived>, )

Creates the archived version of this value at the given position and writes it to the given output.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

impl Clone for VectorMetric

fn clone(&self) -> VectorMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VectorMetric

impl Debug for VectorMetric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VectorMetric

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<VectorMetric, __D> for Archived<VectorMetric>

fn deserialize( &self, deserializer: &mut __D, ) -> Result<VectorMetric, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Eq for VectorMetric

impl Hash for VectorMetric

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for VectorMetric

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<__S: Fallible + ?Sized> Serialize<__S> for VectorMetric

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl StructuralPartialEq for VectorMetric