Struct RaBitQIndex 

pub struct RaBitQIndex {
    pub config: RaBitQConfig,
    pub centroid: Vec<f32>,
    pub random_signs: Vec<i8>,
    pub random_perm: Vec<u32>,
    pub vectors: Vec<QuantizedVector>,
    pub raw_vectors: Option<Vec<Vec<f32>>>,
}

RaBitQ index for dense vector search

Fields

config: RaBitQConfig

Configuration

centroid: Vec<f32>

Centroid of all indexed vectors

random_signs: Vec<i8>

Random orthogonal matrix P (stored as flat array, row-major) For efficiency, we use a random sign-flip + permutation instead of full matrix

random_perm: Vec<u32>

vectors: Vec<QuantizedVector>

Quantized vectors

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

Original vectors for re-ranking (optional, can be stored separately)

Implementations

impl RaBitQIndex

pub fn new(config: RaBitQConfig) -> Self

Create a new empty RaBitQ index

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

Build index from a set of vectors

pub fn prepare_query(&self, raw_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

Uses the formula from RaBitQ paper: ||o_r - q_r||^2 = ||o_r - c||^2 + ||q_r - c||^2 - 2 * ||o_r - c|| * ||q_r - c|| * <o, q>

Where <o, q> is estimated from the binary/scalar quantized representations.

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

Search for k nearest neighbors

pub fn len(&self) -> usize

Number of indexed vectors

pub fn is_empty(&self) -> bool

Check if index is empty

pub fn memory_usage(&self) -> usize

Memory usage in bytes

pub fn compression_ratio(&self) -> f32

Compression ratio compared to raw float32 vectors

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.