Struct SparseIndex 

pub struct SparseIndex {
    pub index: InvertedIndex,
    /* private fields */
}

High-level facade over InvertedIndex.

Owns a file path and delegates all indexing/search operations to the underlying InvertedIndex. Persist with save(); reconstruct from disk with open().

Fields

index: InvertedIndex

Implementations

impl SparseIndex

pub fn create(path: &Path) -> Self

Create a fresh empty index that will persist to path.

pub fn open(path: &Path) -> Result<Self>

Open an existing index from path, or create empty if file absent.

pub fn index_document(&mut self, id: &VectorId, text: &str) -> Result<()>

Add or update a document.

pub fn remove_document(&mut self, id: &VectorId) -> Result<()>

Remove a document. Returns NotFound if absent.

pub fn search(&self, query: &str, k: usize) -> Result<Vec<(VectorId, f32)>>

Full-text BM25 search. Returns up to k results sorted by score desc.

pub fn save(&self) -> Result<()>

Persist the index to its file path.

pub fn score( &self, query_text: &str, candidate_ids: &[VectorId], ) -> Result<Vec<(VectorId, f32)>>

Score query_text against a specific set of candidate document IDs.

Tokenizes the query internally. Returns BM25 scores only for the provided candidates. If candidate_ids is empty, all documents are scored (same as score_all but without a k truncation).

pub fn score_all( &self, query_text: &str, k: usize, ) -> Result<Vec<(VectorId, f32)>>

Score query_text against all indexed documents. Returns top k.

pub fn doc_count(&self) -> usize