Struct RaBitQCodebook 

pub struct RaBitQCodebook {
    pub dim: usize,
    pub seed: u64,
    /* private fields */
}

RaBitQ projection codebook: holds the random rotation matrix P.

The matrix is regenerated deterministically from seed — not stored in the serialized form. Call RaBitQCodebook::rebuild_proj after deserialization before calling encode or prepare_query.

Fields

dim: usize

seed: u64

Implementations

impl RaBitQCodebook

pub fn new(dim: usize, seed: u64) -> Self

Build a new codebook from a seed.

pub fn rebuild_proj(&mut self)

Regenerate the projection matrix after deserialization. Must be called before encode/prepare_query when deserializing.

pub fn is_ready(&self) -> bool

pub fn project(&self, v: &[f32]) -> Vec<f32>

Apply projection P to vector v (F32 → F32).

pub fn encode(&self, v: &[f32]) -> RaBitQVec

Encode a database vector to a RaBitQVec.

The input vector is normalized to unit length before rotation so that the binary code is independent of magnitude; the original norm is stored separately for Euclidean distance estimation.

pub fn prepare_query(&self, q: &[f32]) -> (Vec<f32>, f32)

Prepare a query for search: project + compute scale. Returns (projected_query, scale) where projected_query has dim elements.

pub fn estimate_ip_binary( &self, b_q: &[u8], q_scale: f32, entry: &RaBitQVec, ) -> f32

Estimate inner product using pre-binarized query codes.

b_q: bits_from_signs(q_proj) — compute once per query, reuse for all entries. q_scale: output of prepare_query().1. This avoids recomputing bits_from_signs inside the parallel search loop.

pub fn estimate_ip( &self, q_proj: &[f32], q_scale: f32, entry: &RaBitQVec, ) -> f32

Estimate inner product between a prepared query and a database entry.

q_proj: output of prepare_query().0 q_scale: output of prepare_query().1

Prefer [estimate_ip_binary] when calling in a tight loop — it avoids recomputing bits_from_signs for every entry.

Trait Implementations

impl Clone for RaBitQCodebook

fn clone(&self) -> RaBitQCodebook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RaBitQCodebook

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RaBitQCodebook

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RaBitQCodebook

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

where __S: Serializer,

Serialize this value into the given Serde serializer.