Skip to main content

IndexMetric

Enum IndexMetric 

Source
pub enum IndexMetric {
    Cosine,
    L2,
}
Expand description

The distance a Module-origin vector index was declared to minimise.

Only a vector index has one of these, and only a real one. An ordinary b-tree orders by a collation, not a distance, so every IndexInfo that is not IndexOrigin::Module carries None. A Module index carries None too unless its own module is one the planner has verified actually honours the setting: inillucent-engine/src/vectors.rs only ever reports Some for inillucent_search (which backs USING inillucent_hnsw), because that is the one module whose store was changed to read the graph under this metric. An ivfflat index that was declared WITH (metric = 'l2') still reads back as None here, deliberately: ivfflat’s own argument parser silently accepts and ignores a key it does not recognise, so trusting the text would let the planner believe an index orders by Euclidean distance when the structure behind it still computes cosine - the exact “wrong answer that looks like a working index” this field exists to prevent.

Variants§

§

Cosine

One minus the cosine similarity of two unit vectors.

§

L2

Euclidean distance.

Trait Implementations§

Source§

impl Clone for IndexMetric

Source§

fn clone(&self) -> Self

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 IndexMetric

Source§

impl Debug for IndexMetric

Source§

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

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

impl Eq for IndexMetric

Source§

impl PartialEq for IndexMetric

Source§

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

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.