Struct SpFreshIndex 

pub struct SpFreshIndex { /* private fields */ }

SPFresh Index implementation

Implementations

impl SpFreshIndex

pub fn new(config: SpFreshConfig) -> Self

Create a new SPFresh index

pub fn is_trained(&self) -> bool

Check if index is trained

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

Get vector dimension

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

Train the index with initial vectors using k-means

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

Add vectors to the index (LIRE: lazy insertion)

pub fn remove(&self, ids: &[VectorId]) -> usize

Remove vectors by ID (LIRE: tombstone-based)

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

Search for nearest neighbors

pub fn compact(&self) -> usize

Trigger compaction on clusters exceeding tombstone threshold

pub fn merge_small_clusters(&self) -> usize

Merge small clusters

pub fn stats(&self) -> SpFreshStats

Get index statistics

pub fn config(&self) -> &SpFreshConfig

Get configuration

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

Restore SPFresh index from a full snapshot

Trait Implementations

impl Persistable for SpFreshIndex

type Snapshot = SpFreshFullSnapshot

The snapshot type for this index

fn to_snapshot(&self) -> SpFreshFullSnapshot

Create a snapshot of the current state

fn from_snapshot(snapshot: SpFreshFullSnapshot) -> 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)