IVFRaBitQIndex

Struct IVFRaBitQIndex 

Source
pub struct IVFRaBitQIndex {
    pub config: IVFConfig,
    pub centroids_version: u64,
    pub random_signs: Vec<i8>,
    pub random_perm: Vec<u32>,
    pub clusters: HashMap<u32, ClusterData>,
    pub num_vectors: usize,
}
Expand description

IVF-RaBitQ index for a single segment

Fields§

§config: IVFConfig

Configuration

§centroids_version: u64

Version of coarse centroids used (for merge compatibility)

§random_signs: Vec<i8>

Random signs for transform (+1 or -1)

§random_perm: Vec<u32>

Random permutation for transform

§clusters: HashMap<u32, ClusterData>

Cluster data (sparse - only populated clusters)

§num_vectors: usize

Total number of vectors indexed

Implementations§

Source§

impl IVFRaBitQIndex

Source

pub fn new(config: IVFConfig, centroids_version: u64) -> Self

Create a new empty IVF index

Source

pub fn build( config: IVFConfig, coarse_centroids: &CoarseCentroids, vectors: &[Vec<f32>], doc_ids: Option<&[u32]>, ) -> Self

Build index from vectors using provided coarse centroids

Source

pub fn add_vector( &mut self, coarse_centroids: &CoarseCentroids, doc_id: u32, vector: &[f32], )

Add a single vector to the index

Source

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

Search for k nearest neighbors

Source

pub fn merge( indexes: &[&IVFRaBitQIndex], doc_id_offsets: &[u32], ) -> Result<Self, &'static str>

Merge multiple IVF indexes (O(1) per cluster - just concatenate)

Source

pub fn num_clusters(&self) -> usize

Get number of populated clusters

Source

pub fn len(&self) -> usize

Get total number of vectors

Source

pub fn is_empty(&self) -> bool

Source

pub fn size_bytes(&self) -> usize

Approximate size in bytes

Trait Implementations§

Source§

impl Clone for IVFRaBitQIndex

Source§

fn clone(&self) -> IVFRaBitQIndex

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IVFRaBitQIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for IVFRaBitQIndex

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for IVFRaBitQIndex

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,