Skip to main content

PQScratch

Struct PQScratch 

Source
pub struct PQScratch {
    pub aligned_pqtable_dist_scratch: Poly<[f32], AlignedAllocator>,
    pub aligned_dist_scratch: Poly<[f32], AlignedAllocator>,
    pub aligned_pq_coord_scratch: Poly<[u8], AlignedAllocator>,
    pub query_scratch: Vec<f32>,
}
Expand description

PQ scratch

Fields§

§aligned_pqtable_dist_scratch: Poly<[f32], AlignedAllocator>

Aligned pq table distance scratch, the length must be at least [256 * NCHUNKS]. 256 is the number of PQ centroids. This is used to store the distance between each chunk in the query vector to each centroid, which is why the length is num of centroids * num of chunks

§aligned_dist_scratch: Poly<[f32], AlignedAllocator>

Aligned dist scratch, must be at least diskann MAX_DEGREE This is used to temporarily save the pq distance between query vector to the candidate vectors.

§aligned_pq_coord_scratch: Poly<[u8], AlignedAllocator>

Aligned pq coord scratch, must be at least [N_CHUNKS * MAX_DEGREE] This is used to store the pq coordinates of the candidate vectors.

§query_scratch: Vec<f32>

Query scratch buffer stored as f32, sized by the PQ table’s logical dimension. set populates it from a caller-provided &[f32]; PQTable::preprocess_query can then rotate or otherwise preprocess it.

Implementations§

Source§

impl PQScratch

Source

pub fn new( graph_degree: usize, dim: usize, num_pq_chunks: usize, num_centers: usize, ) -> ANNResult<Self>

Create a new pq scratch.

dim is the PQ table’s logical dimension (PQData::get_dim()); the internal query_scratch buffer is sized to exactly this many f32 slots.

Source

pub fn set(&mut self, query: &[f32]) -> ANNResult<()>

Copy the first dim elements of query into query_scratch.

query must already be in full-precision f32 representation; quantized inputs (e.g. MinMaxElement) should be decoded via VectorRepr::as_f32 at the caller boundary before invoking this method.

Accepts oversized query (only the first dim elements are used) for backwards compatibility with callers that hold alignment-padded buffers. Returns DimensionMismatchError if query.len() < query_scratch.len().

Trait Implementations§

Source§

impl Debug for PQScratch

Source§

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

Formats the value using the given formatter. 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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> AsyncFriendly for T
where T: Send + Sync + 'static,