Struct arroy::Reader

pub struct Reader<'t, D: Distance> { /* private fields */ }

A reader over the arroy trees and user items.

Implementations

impl<'t, D: Distance> Reader<'t, D>

pub fn open( rtxn: &'t RoTxn<'_>, index: u16, database: Database<D>, ) -> Result<Reader<'t, D>>

Returns a reader over the database with the specified Distance type.

pub fn dimensions(&self) -> usize

Returns the number of dimensions in the index.

pub fn n_trees(&self) -> usize

Returns the number of trees in the index.

pub fn n_items(&self) -> u64

Returns the number of vectors stored in the index.

pub fn item_ids(&self) -> &RoaringBitmap

Returns all the item ids contained in this index.

pub fn index(&self) -> u16

Returns the index of this reader in the database.

pub fn stats(&self, rtxn: &RoTxn<'_>) -> Result<Stats>

Returns the stats of the trees of this database.

pub fn n_nodes(&self, rtxn: &'t RoTxn<'_>) -> Result<Option<NonZeroUsize>>

Returns the number of nodes in the index. Useful to run an exhaustive search.

pub fn item_vector( &self, rtxn: &'t RoTxn<'_>, item: ItemId, ) -> Result<Option<Vec<f32>>>

Returns the vector for item i that was previously added.

pub fn is_empty(&self, rtxn: &RoTxn<'_>) -> Result<bool>

Returns true if the index is empty.

pub fn contains_item(&self, rtxn: &RoTxn<'_>, item: ItemId) -> Result<bool>

Returns true if the database contains the given item.

pub fn iter(&self, rtxn: &'t RoTxn<'_>) -> Result<ItemIter<'t, D>>

Returns an iterator over the items vector.

pub fn nns_by_item( &self, rtxn: &'t RoTxn<'_>, item: ItemId, count: usize, search_k: Option<NonZeroUsize>, candidates: Option<&RoaringBitmap>, ) -> Result<Option<Vec<(ItemId, f32)>>>

Returns the count closests items from item.

During the query it will inspect up to search_k nodes which defaults to n_trees * count if not provided. search_k gives you a run-time tradeoff between better accuracy and speed.

The candidates parameter corresponds to the subset of item ids arroy will return.

pub fn nns_by_vector( &self, rtxn: &'t RoTxn<'_>, vector: &[f32], count: usize, search_k: Option<NonZeroUsize>, candidates: Option<&RoaringBitmap>, ) -> Result<Vec<(ItemId, f32)>>

Returns the count closest items from the provided vector.

See Reader::nns_by_item for more details.

Trait Implementations

impl<'t, D: Debug + Distance> Debug for Reader<'t, D>

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

Formats the value using the given formatter.