Skip to main content

VectorIndex

Struct VectorIndex 

Source
pub struct VectorIndex { /* private fields */ }
Expand description

An on-node embedding index.

Implementations§

Source§

impl VectorIndex

Source

pub fn new(dim: usize, metric: Metric) -> Self

A new dim-dimensional index ranked by metric.

Examples found in repository?
examples/ir_vector.rs (line 25)
7fn main() {
8    let dim = 64;
9    let n = 1500;
10    let mut s = 0x9E3779B97F4A7C15u64;
11    let mut next = move || {
12        s ^= s << 13;
13        s ^= s >> 7;
14        s ^= s << 17;
15        ((s >> 40) as f32 / (1u64 << 24) as f32) - 0.5
16    };
17    let vectors: Vec<Vec<f32>> = (0..n).map(|_| (0..dim).map(|_| next()).collect()).collect();
18    let queries: Vec<Vec<f32>> = (0..12)
19        .map(|_| (0..dim).map(|_| next()).collect())
20        .collect();
21
22    let mut check = 0u64;
23    let mut found = 0usize;
24    for metric in [Metric::Cosine, Metric::Dot, Metric::Euclidean] {
25        let mut index = VectorIndex::new(dim, metric);
26        for (i, v) in vectors.iter().enumerate() {
27            index.insert(format!("item-{i:05}"), v.clone()).unwrap();
28        }
29        for q in &queries {
30            for m in index.search(q, 10).unwrap() {
31                check = (check ^ m.score.to_bits() as u64).wrapping_mul(0x100000001b3);
32                check ^= m.id.len() as u64 + m.id.as_bytes()[9] as u64;
33                found += 1;
34            }
35        }
36    }
37    println!("found {found} check {check:016x}");
38}
Source

pub fn dim(&self) -> usize

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn insert( &mut self, id: impl Into<String>, vector: Vec<f32>, ) -> VectorResult<()>

Insert (or replace) the embedding for id. Errors on a dimension mismatch.

Examples found in repository?
examples/ir_vector.rs (line 27)
7fn main() {
8    let dim = 64;
9    let n = 1500;
10    let mut s = 0x9E3779B97F4A7C15u64;
11    let mut next = move || {
12        s ^= s << 13;
13        s ^= s >> 7;
14        s ^= s << 17;
15        ((s >> 40) as f32 / (1u64 << 24) as f32) - 0.5
16    };
17    let vectors: Vec<Vec<f32>> = (0..n).map(|_| (0..dim).map(|_| next()).collect()).collect();
18    let queries: Vec<Vec<f32>> = (0..12)
19        .map(|_| (0..dim).map(|_| next()).collect())
20        .collect();
21
22    let mut check = 0u64;
23    let mut found = 0usize;
24    for metric in [Metric::Cosine, Metric::Dot, Metric::Euclidean] {
25        let mut index = VectorIndex::new(dim, metric);
26        for (i, v) in vectors.iter().enumerate() {
27            index.insert(format!("item-{i:05}"), v.clone()).unwrap();
28        }
29        for q in &queries {
30            for m in index.search(q, 10).unwrap() {
31                check = (check ^ m.score.to_bits() as u64).wrapping_mul(0x100000001b3);
32                check ^= m.id.len() as u64 + m.id.as_bytes()[9] as u64;
33                found += 1;
34            }
35        }
36    }
37    println!("found {found} check {check:016x}");
38}
Source

pub fn remove(&mut self, id: &str) -> bool

Remove id. Returns whether it was present.

Source

pub fn search(&self, query: &[f32], k: usize) -> VectorResult<Vec<Match>>

Return the top-k entries nearest to query, highest score first. Ties break by id for deterministic (corroboratable) results. Errors on a dimension mismatch.

Examples found in repository?
examples/ir_vector.rs (line 30)
7fn main() {
8    let dim = 64;
9    let n = 1500;
10    let mut s = 0x9E3779B97F4A7C15u64;
11    let mut next = move || {
12        s ^= s << 13;
13        s ^= s >> 7;
14        s ^= s << 17;
15        ((s >> 40) as f32 / (1u64 << 24) as f32) - 0.5
16    };
17    let vectors: Vec<Vec<f32>> = (0..n).map(|_| (0..dim).map(|_| next()).collect()).collect();
18    let queries: Vec<Vec<f32>> = (0..12)
19        .map(|_| (0..dim).map(|_| next()).collect())
20        .collect();
21
22    let mut check = 0u64;
23    let mut found = 0usize;
24    for metric in [Metric::Cosine, Metric::Dot, Metric::Euclidean] {
25        let mut index = VectorIndex::new(dim, metric);
26        for (i, v) in vectors.iter().enumerate() {
27            index.insert(format!("item-{i:05}"), v.clone()).unwrap();
28        }
29        for q in &queries {
30            for m in index.search(q, 10).unwrap() {
31                check = (check ^ m.score.to_bits() as u64).wrapping_mul(0x100000001b3);
32                check ^= m.id.len() as u64 + m.id.as_bytes()[9] as u64;
33                found += 1;
34            }
35        }
36    }
37    println!("found {found} check {check:016x}");
38}

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> 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> Same for T

Source§

type Output = T

Should always be Self
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.