Struct flechasdb::db::build::Database

pub struct Database<T, VS>where
    VS: VectorSet<T>,{ /* private fields */ }

Database.

Implementations

impl<T, VS> Database<T, VS>where VS: VectorSet<T>,

pub fn num_vectors(&self) -> usize

Returns the number of vectors in the database.

pub const fn vector_size(&self) -> usize

Returns the vector size.

pub const fn num_partitions(&self) -> usize

Returns the number of partitions.

pub const fn num_divisions(&self) -> usize

Returns the number of subvector divisions.

pub fn subvector_size(&self) -> usize

Returns the size of a subvector.

pub const fn num_clusters(&self) -> usize

Returns the number of clusters.

pub fn vector_ids(&self) -> impl Iterator<Item = &Uuid>

Returns an iterator of vector IDs.

pub fn partitions(&self) -> PartitionIter<'_, T, VS>

Returns an iterator of partitions.

pub fn get_attribute<K>( &self, id: &Uuid, key: &K ) -> Result<Option<&AttributeValue>, Error>where String: Borrow<K>, K: Hash + Eq + ?Sized,

Returns the attribute value of a given vector.

Fails if no vector is associated with id.

pub fn set_attribute_at<KV, KEY, VAL>( &mut self, i: usize, attribute: KV ) -> Result<(), Error>where KV: Into<(KEY, VAL)>, KEY: Into<String>, VAL: Into<AttributeValue>,

Sets an attribute value for the i-th vector.

Replaces with the new value if the vector already has the attribute.

Fails if i is out of bounds.

impl<T, VS> Database<T, VS>where T: Scalar, VS: VectorSet<T>,

pub fn query<V>( &self, v: &V, k: NonZeroUsize, nprobe: NonZeroUsize ) -> Result<Vec<QueryResult<T>>, Error>where V: AsSlice<T> + ?Sized,

Queries k-nearest neighbors (k-NN) of a given vector.

pub fn query_with_events<V, EventHandler>( &self, v: &V, k: NonZeroUsize, nprobe: NonZeroUsize, event: EventHandler ) -> Result<Vec<QueryResult<T>>, Error>where V: AsSlice<T> + ?Sized, EventHandler: FnMut(QueryEvent),

Queries k-nearest neighbors (k-NN) of a given vector.