Struct VectorLite

pub struct VectorLite<const N: usize> { /* private fields */ }

A lightweight lsh-based ann index.

Implementations

impl<const N: usize> VectorLite<N>

pub fn new(num_trees: usize, max_leaf_size: usize) -> Self

Create a new VectorLite index with the given number of trees and max leaf size. More trees means more accuracy but slower search and larger memory usage. Lower max_leaf_size means higher accuracy but larger memory usage.

pub fn len(&self) -> usize

Get the number of vectors in the index.

pub fn is_empty(&self) -> bool

Check if the index is empty.

pub fn index(&self) -> &VectorLiteIndex<N>

Get the index.

pub fn to_bytes(&self) -> Vec<u8>

Serialize the index to a byte vector.

pub fn from_bytes(bytes: &[u8]) -> Self

Deserialize the index from a byte vector.

Trait Implementations

impl<const N: usize> ANNIndexOwned<N> for VectorLite<N>

fn insert_with_rng(&mut self, vector: Vector<N>, id: String, rng: &mut impl Rng)

Insert a vector into the index with a custom rng.

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

Delete a vector from the index by id. Returns true if the vector was deleted, false if it was not found.

fn get_by_id(&self, id: &str) -> Option<&Vector<N>>

Get a vector from the index by id.

fn search_with_metric( &self, query: &Vector<N>, top_k: usize, metric: ScoreMetric, ) -> Vec<(String, f32)>

Search for the top_k nearest neighbors of the query vector. Returns a array of (id, score) pairs, higher score means closer.

fn insert(&mut self, vector: Vector<N>, id: String)

Insert a vector into the index.

fn search(&self, query: &Vector<N>, top_k: usize) -> Vec<(String, f32)>

Search for the top_k nearest neighbors of the query vector. Returns a array of (id, score) pairs, higher score means closer.

impl<'__de, const N: usize, __Context> BorrowDecode<'__de, __Context> for VectorLite<N>

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl<const N: usize, __Context> Decode<__Context> for VectorLite<N>

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<const N: usize> Encode for VectorLite<N>

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.