Struct BinaryIvfIndex 

pub struct BinaryIvfIndex {
    pub config: BinaryIvfConfig,
    /* private fields */
}

IVF index over packed binary vectors (Hamming distance).

Fields

config: BinaryIvfConfig

Implementations

impl BinaryIvfIndex

pub fn build( config: BinaryIvfConfig, codes: &[u8], doc_id_ordinals: &[(u32, u16)], ) -> Self

Train centroids via k-majority and build the index from packed vectors.

codes is n × byte_len contiguous packed vectors; doc_id_ordinals[i] labels vector i.

pub fn search( &self, query: &[u8], k: usize, nprobe: Option<usize>, ) -> Vec<(u32, u16, f32)>

Search: probe nprobe nearest clusters, exact Hamming within each.

Returns (doc_id, ordinal, similarity) with similarity = 1 - hamming/dim, sorted descending — exact for every scanned vector.

pub fn merge_into(&mut self, other: &BinaryIvfIndex, doc_id_offset: u32)

Merge another index into this one, re-assigning its vectors to this index’s centroids. Lossless: cluster payloads are the exact codes.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn num_clusters(&self) -> usize

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

Serialize to compact bytes (bincode).

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

Deserialize from bytes.

pub fn estimated_memory_bytes(&self) -> usize

Estimated memory usage in bytes.

Trait Implementations

impl Clone for BinaryIvfIndex

fn clone(&self) -> BinaryIvfIndex

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BinaryIvfIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BinaryIvfIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BinaryIvfIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.