Struct LshIndex 

pub struct LshIndex { /* private fields */ }

A locality-sensitive hashing index for approximate nearest-neighbor search.

Thread-safe: concurrent reads (queries) proceed in parallel; writes (inserts, removes) acquire exclusive access via parking_lot::RwLock.

Implementations

impl LshIndex

pub fn builder() -> LshIndexBuilder

Start building an index with the builder pattern.

pub fn new(config: IndexConfig) -> Result<Self>

Create an index directly from an IndexConfig.

pub fn insert(&self, id: usize, vector: &[f32]) -> Result<()>

Insert a vector with the given ID.

If a vector with this ID already exists it is silently replaced.

pub fn insert_auto(&self, vector: &[f32]) -> Result<usize>

Insert a vector and receive an auto-assigned ID.

The ID is assigned atomically under the write lock, so concurrent calls will never produce duplicate IDs.

pub fn insert_batch(&self, vectors: &[(usize, &[f32])]) -> Result<()>

Insert multiple vectors at once. Aborts on first error.

pub fn query(&self, vector: &[f32], k: usize) -> Result<Vec<QueryResult>>

Find the k approximate nearest neighbors for vector.

Returns results sorted by ascending distance (closest first).

pub fn remove(&self, id: usize) -> Result<()>

Remove a vector by ID.

pub fn contains(&self, id: usize) -> bool

Check whether a vector ID is present.

pub fn len(&self) -> usize

Number of stored vectors.

pub fn is_empty(&self) -> bool

True when the index holds no vectors.

pub fn stats(&self) -> IndexStats

Compute aggregate statistics about the index.

pub fn metrics(&self) -> Option<MetricsSnapshot>

Snapshot of runtime metrics (None if metrics were not enabled).

pub fn reset_metrics(&self)

Reset metrics counters.

pub fn clear(&self)

Remove all vectors from the index (projections are preserved).

pub fn config(&self) -> IndexConfig

Return a clone of the current configuration.

Trait Implementations

impl Debug for LshIndex

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

Formats the value using the given formatter.