Skip to main content

QueryMatRef

Struct QueryMatRef 

Source
pub struct QueryMatRef<'a, T: Repr>(pub MatRef<'a, T>);
Expand description

A query matrix view for asymmetric distance functions.

This wrapper distinguishes query matrices from document matrices at compile time, preventing accidental argument swapping in asymmetric distance computations like MaxSim and Chamfer.

§Example

use diskann_quantization::multi_vector::{MatRef, Standard};
use diskann_quantization::multi_vector::distance::QueryMatRef;

let data = [1.0f32, 2.0, 3.0, 4.0];
let view = MatRef::new(Standard::new(2, 2), &data).unwrap();
let query: QueryMatRef<_> = view.into();

Tuple Fields§

§0: MatRef<'a, T>

Methods from Deref<Target = MatRef<'a, T>>§

Source

pub fn num_vectors(&self) -> usize

Returns the number of rows (vectors) in the matrix.

Source

pub fn repr(&self) -> &T

Returns a reference to the underlying representation.

Source

pub fn get_row(&self, i: usize) -> Option<T::Row<'_>>

Returns an immutable reference to the i-th row, or None if out of bounds.

Source

pub fn rows(&self) -> Rows<'_, T>

Returns an iterator over immutable row references.

Trait Implementations§

Source§

impl<'a, T: Clone + Repr> Clone for QueryMatRef<'a, T>

Source§

fn clone(&self) -> QueryMatRef<'a, T>

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<'a, T: Debug + Repr> Debug for QueryMatRef<'a, T>

Source§

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

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

impl<'a, T: Repr> Deref for QueryMatRef<'a, T>

Deref so that we can transparently access the MatRef in distance functions.

Source§

type Target = MatRef<'a, T>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<const NBITS: usize> DistanceFunctionMut<QueryMatRef<'_, MinMaxMeta<NBITS>>, MatRef<'_, MinMaxMeta<NBITS>>> for MaxSim<'_>

Source§

fn evaluate( &mut self, query: QueryMatRef<'_, MinMaxMeta<NBITS>>, doc: MatRef<'_, MinMaxMeta<NBITS>>, )

Compute distances between the left and right arguments.
Source§

impl<T: Copy> DistanceFunctionMut<QueryMatRef<'_, Standard<T>>, MatRef<'_, Standard<T>>, Result<(), MaxSimError>> for MaxSim<'_>
where InnerProduct: for<'a, 'b> PureDistanceFunction<&'a [T], &'b [T], f32>,

Source§

fn evaluate( &mut self, query: QueryMatRef<'_, Standard<T>>, doc: MatRef<'_, Standard<T>>, ) -> Result<(), MaxSimError>

Compute distances between the left and right arguments.
Source§

impl<'a, T: Repr> From<MatRef<'a, T>> for QueryMatRef<'a, T>

Source§

fn from(view: MatRef<'a, T>) -> Self

Converts to this type from the input type.
Source§

impl<const NBITS: usize> PureDistanceFunction<QueryMatRef<'_, MinMaxMeta<NBITS>>, MatRef<'_, MinMaxMeta<NBITS>>> for Chamfer

Source§

fn evaluate( query: QueryMatRef<'_, MinMaxMeta<NBITS>>, doc: MatRef<'_, MinMaxMeta<NBITS>>, ) -> f32

Source§

impl<T: Copy> PureDistanceFunction<QueryMatRef<'_, Standard<T>>, MatRef<'_, Standard<T>>> for Chamfer
where InnerProduct: for<'a, 'b> PureDistanceFunction<&'a [T], &'b [T], f32>,

Source§

fn evaluate( query: QueryMatRef<'_, Standard<T>>, doc: MatRef<'_, Standard<T>>, ) -> f32

Source§

impl<'a, T: Copy + Repr> Copy for QueryMatRef<'a, T>

Auto Trait Implementations§

§

impl<'a, T> Freeze for QueryMatRef<'a, T>
where T: Freeze,

§

impl<'a, T> RefUnwindSafe for QueryMatRef<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for QueryMatRef<'a, T>
where T: Send,

§

impl<'a, T> Sync for QueryMatRef<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for QueryMatRef<'a, T>
where T: Unpin,

§

impl<'a, T> UnwindSafe for QueryMatRef<'a, T>
where T: 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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> Generator<T> for T
where T: Clone,

Source§

fn generate(&mut self) -> T

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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> AsyncFriendly for T
where T: Send + Sync + 'static,