Struct RaBitQIndex 

pub struct RaBitQIndex {
    pub codebook: RaBitQCodebook,
    pub centroid: Vec<f32>,
    pub doc_ids: Vec<u32>,
    pub ordinals: Vec<u16>,
    pub vectors: Vec<QuantizedVector>,
    pub raw_vectors: Option<Vec<Vec<f32>>>,
}

Standalone RaBitQ index for small datasets

Uses brute-force search over all quantized vectors. For larger datasets, use IVFRaBitQIndex instead.

Fields

codebook: RaBitQCodebook

RaBitQ codebook (random transform parameters)

centroid: Vec<f32>

Centroid of all indexed vectors

doc_ids: Vec<u32>

Document IDs

ordinals: Vec<u16>

Element ordinals for multi-valued fields (0 for single-valued)

vectors: Vec<QuantizedVector>

Quantized vectors

raw_vectors: Option<Vec<Vec<f32>>>

Raw vectors for re-ranking (optional)

Implementations

impl RaBitQIndex

pub fn new(config: RaBitQConfig) -> Self

Create a new empty RaBitQ index

pub fn build_with_ids( config: RaBitQConfig, vectors: &[(u32, u16, Vec<f32>)], store_raw: bool, ) -> Self

Build index from vectors with doc IDs and ordinals

pub fn build( config: RaBitQConfig, vectors: &[Vec<f32>], store_raw: bool, ) -> Self

Build index from a set of vectors (legacy, uses doc_id = index, ordinal = 0)

pub fn add_vector( &mut self, doc_id: u32, ordinal: u16, vector: &[f32], raw: Option<Vec<f32>>, )

Add a single vector to the index

pub fn prepare_query(&self, query: &[f32]) -> QuantizedQuery

Prepare a query for fast distance estimation

pub fn estimate_distance(&self, query: &QuantizedQuery, vec_idx: usize) -> f32

Estimate squared distance between query and a quantized vector

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

Search for k nearest neighbors, returns (doc_id, ordinal, distance)

pub fn len(&self) -> usize

Number of indexed vectors

pub fn is_empty(&self) -> bool

pub fn size_bytes(&self) -> usize

Memory usage in bytes

pub fn compression_ratio(&self) -> f32

Compression ratio compared to raw float32 vectors

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

Serialize to bytes

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

Deserialize from bytes

Trait Implementations

impl Clone for RaBitQIndex

fn clone(&self) -> RaBitQIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RaBitQIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RaBitQIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RaBitQIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.