Skip to main content

ClusterData

Struct ClusterData 

Source
pub struct ClusterData<C: Clone> {
    pub doc_ids: Vec<u32>,
    pub codes: Vec<C>,
    pub raw_vectors: Option<Vec<Vec<f32>>>,
}
Expand description

Generic cluster data storage

Stores document IDs and quantized codes for vectors in a cluster. Can optionally store raw vectors for re-ranking.

Fields§

§doc_ids: Vec<u32>

Document IDs (local to segment)

§codes: Vec<C>

Quantized vector codes

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

Raw vectors for re-ranking (optional)

Implementations§

Source§

impl<C: Clone> ClusterData<C>

Source

pub fn new() -> Self

Source

pub fn with_capacity(capacity: usize) -> Self

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn add(&mut self, doc_id: u32, code: C, raw_vector: Option<Vec<f32>>)

Add a vector to the cluster

Source

pub fn append(&mut self, other: &ClusterData<C>, doc_id_offset: u32)

Append another cluster’s data (for merging segments)

Source

pub fn iter(&self) -> impl Iterator<Item = (u32, &C)>

Get iterator over (doc_id, code) pairs

Source

pub fn iter_with_raw( &self, ) -> impl Iterator<Item = (u32, &C, Option<&Vec<f32>>)>

Get iterator over (doc_id, code, optional raw_vector) tuples

Source

pub fn clear(&mut self)

Clear all data

Source

pub fn reserve(&mut self, additional: usize)

Reserve capacity

Source§

impl<C: Clone + QuantizedCode> ClusterData<C>

Source

pub fn size_bytes(&self) -> usize

Memory usage in bytes

Trait Implementations§

Source§

impl<C: Clone + Clone> Clone for ClusterData<C>

Source§

fn clone(&self) -> ClusterData<C>

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<C: Debug + Clone> Debug for ClusterData<C>

Source§

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

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

impl<C: Clone> Default for ClusterData<C>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de, C> Deserialize<'de> for ClusterData<C>
where C: Deserialize<'de> + Clone,

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<C> Serialize for ClusterData<C>
where C: Serialize + Clone,

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§

§

impl<C> Freeze for ClusterData<C>

§

impl<C> RefUnwindSafe for ClusterData<C>
where C: RefUnwindSafe,

§

impl<C> Send for ClusterData<C>
where C: Send,

§

impl<C> Sync for ClusterData<C>
where C: Sync,

§

impl<C> Unpin for ClusterData<C>
where C: Unpin,

§

impl<C> UnwindSafe for ClusterData<C>
where C: UnwindSafe,

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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>,