Struct Vectors

Source

pub struct Vectors { /* private fields */ }

Expand description

A collection of vectors, reached by Db::vectors.

Keys are byte strings the way the keyspace’s are, so anything that is bytes will do.

Implementations§

Source §

impl Vectors

Source

pub fn dim(&self) -> usize

How many coordinates a vector in this collection has.

Source

pub fn metric(&self) -> Metric

What nearness means here.

Source

pub fn put(&self, key: impl AsRef<[u8]>, v: &[f32]) -> Result<bool>

Put a vector in under key, and say whether the key is new.

Replacing is the same call, which is what makes re-embedding a document one line. The old code comes out of its partition and the new one goes into whichever partition it belongs to now, so nothing accumulates and there is no rebuild waiting at the end of it.

§Errors

Code::Invalid when the vector is not Vectors::dim long, when it holds a coordinate that is not a number, or when a cosine collection is handed a vector of length zero, which has no direction to store. Code::Full for a key past the length limit.

Source

pub fn get(&self, key: impl AsRef<[u8]>) -> Result<Option<Vec<f32>>>

The vector under key, if there is one.

A cosine collection hands back the unit vector it stored rather than the one it was given. See the module note on the metric for why.

§Errors

Code::Invalid if called from inside a callback that is already holding this database.

Source

pub fn with<R>( &self, key: impl AsRef<[u8]>, f: impl FnOnce(&[f32]) -> R, ) -> Result<Option<R>>

The same, handed to a closure where it lies, which copies nothing.

The owned form is what most code wants and this is Y29’s other half: the vectors are contiguous floats already, so a caller that only wants to measure one against something never has to allocate to do it.

§Errors

As Vectors::get.

Source

pub fn contains(&self, key: impl AsRef<[u8]>) -> Result<bool>

Whether the collection holds a vector under key.

§Errors

As Vectors::get.

Source

pub fn remove(&self, key: impl AsRef<[u8]>) -> Result<bool>

Take a vector out, saying whether it was there.

A delete here is a delete and not a tombstone: the member leaves its posting and the last member of that posting moves into the hole. That is the difference between this and a graph index, where deletes pile up until somebody rebuilds.

§Errors

As Vectors::get.

Source

pub fn len(&self) -> Result<usize>

How many vectors are in the collection.

§Errors

As Vectors::get.

Source

pub fn is_empty(&self) -> Result<bool>

Whether there are none.

§Errors

As Vectors::get.

Source

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

The k nearest keys to q, nearest first.

Fewer than k come back when the collection holds fewer than that, and nothing comes back from an empty one.

let db = yo::open(yo::MEMORY)?;
let v = db.vectors("words", 2)?;

v.put("north", &[0.0, 1.0])?;
v.put("east", &[1.0, 0.0])?;
v.put("west", &[-1.0, 0.0])?;

let hits = v.search(&[0.2, 0.9], 2)?;
assert_eq!(hits[0].key, b"north".to_vec());
assert_eq!(hits.len(), 2);