Struct IvfIndex 

pub struct IvfIndex { /* private fields */ }

IVF Index for approximate nearest neighbor search

Implementations

impl IvfIndex

pub fn new(config: IvfConfig) -> Self

Create a new IVF index with the given configuration

pub fn with_defaults() -> Self

Create with default configuration

pub fn train(&mut self, vectors: &[Vec<f32>]) -> Result<(), String>

Train the index using k-means clustering

pub fn add(&self, id: String, vector: Vec<f32>) -> Result<(), String>

Add a vector to the index (must be trained first)

pub fn add_batch( &self, vectors: Vec<(String, Vec<f32>)>, ) -> Result<usize, String>

Add multiple vectors to the index

pub fn search( &self, query: &[f32], k: usize, ) -> Result<Vec<SearchResult>, String>

Search for the k nearest neighbors

pub fn remove(&self, id: &str) -> bool

Remove a vector by ID

pub fn len(&self) -> usize

Get total number of indexed vectors

pub fn is_empty(&self) -> bool

Check if index is empty

pub fn is_trained(&self) -> bool

Check if index is trained

pub fn n_clusters(&self) -> usize

Get number of clusters

pub fn config(&self) -> &IvfConfig

Get configuration

pub fn dimension(&self) -> Option<usize>

Get dimension

pub fn from_snapshot(snapshot: IvfFullSnapshot) -> Result<Self, String>

Restore IVF index from a full snapshot

Trait Implementations

impl Persistable for IvfIndex

type Snapshot = IvfFullSnapshot

The snapshot type for this index

fn to_snapshot(&self) -> IvfFullSnapshot

Create a snapshot of the current state

fn from_snapshot(snapshot: IvfFullSnapshot) -> Result<Self, String>

Restore from a snapshot

fn to_bytes(&self) -> Result<Vec<u8>, String>

Serialize to bytes (JSON format)

fn from_bytes(data: &[u8]) -> Result<Self, String>

Deserialize from bytes (JSON format)