Struct MatRef 

pub struct MatRef<'a, T: Repr> { /* private fields */ }

An immutable borrowed view of a matrix.

Provides read-only access to matrix data without ownership. Implements Copy and can be freely cloned.

Type Parameter

• T: A Repr implementation defining the row layout.

Access

• get_row: Get an immutable row by index.
• rows: Iterate over all rows.

Implementations

impl<'a, T: Repr> MatRef<'a, T>

pub fn new<U>(repr: T, data: &'a [U]) -> Result<Self, T::Error>

where T: NewRef<U>,

Construct a new MatRef over data.

pub fn num_vectors(&self) -> usize

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

pub fn repr(&self) -> &T

Returns a reference to the underlying representation.

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.

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

Returns an iterator over immutable row references.

pub fn to_owned(&self) -> Mat<T>

where T: NewCloned,

Return a Mat with the same contents as self.

pub unsafe fn from_raw_parts(repr: T, ptr: NonNull<u8>) -> Self

Construct a new MatRef over the raw pointer and representation without performing any validity checks.

Safety

Argument ptr must point to memory compatible with Repr::layout and pass any validity checks required by T.

pub fn as_raw_ptr(&self) -> *const u8

Return the base pointer for the MatRef.

impl<'a, T: Copy> MatRef<'a, Standard<T>>

pub fn vector_dim(&self) -> usize

Returns the raw dimension (columns) of the vectors in the matrix.

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, 'b, const NBITS: usize, T> CompressInto<MatRef<'a, Standard<T>>, MatMut<'b, MinMaxMeta<NBITS>>> for MinMaxQuantizer

where T: Copy + Into<f32>, Unsigned: Representation<NBITS>,

fn compress_into( &self, from: MatRef<'a, Standard<T>>, to: MatMut<'b, MinMaxMeta<NBITS>>, ) -> Result<(), Self::Error>

Compress a multi-vector of full-precision vectors into a multi-vector of MinMax quantized vectors.

This method iterates row by row over the input matrix, quantizing each full-precision vector into the corresponding row of the output MinMax matrix.

Error

Returns InputContainsNaN error if any input vector contains NaN.

Panics

Panics if:

• from.num_vectors() != to.num_vectors(): The input and output must have the same number of vectors.
• from.vector_dim() != self.dim(): Each input vector must have the same dimensionality as the quantizer.
• The output intrinsic dimension doesn’t match self.output_dim().

type Error = InputContainsNaN

Errors that may occur during compression.

type Output = ()

An output type resulting from compression.

impl<'a, T: Debug + Repr> Debug for MatRef<'a, T>

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

Formats the value using the given formatter.

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

where Unsigned: Representation<NBITS>, InnerProduct: for<'x, 'y> PureDistanceFunction<BitSlice<'x, NBITS, Unsigned>, BitSlice<'y, NBITS, Unsigned>, MathematicalResult<u32>>,

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

Compute distances between the left and right arguments.

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>,

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

Compute distances between the left and right arguments.

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

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

Converts to this type from the input type.

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

where Unsigned: Representation<NBITS>, InnerProduct: for<'a, 'b> PureDistanceFunction<BitSlice<'a, NBITS, Unsigned>, BitSlice<'b, NBITS, Unsigned>, MathematicalResult<u32>>,

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

impl<T: Copy> PureDistanceFunction<QueryMatRef<'_, Standard<T>>, MatRef<'_, Standard<T>>> for Chamfer

where InnerProduct: for<'a, 'b> PureDistanceFunction<&'a [T], &'b [T], f32>,

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

impl<'this, 'a, T: Repr> Reborrow<'this> for MatRef<'a, T>

type Target = MatRef<'this, T>

fn reborrow(&'this self) -> Self::Target

Borrow self into a generalized reference type and reborrow

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

impl<T> Send for MatRef<'_, T>

where T: Repr + Send,

impl<T> Sync for MatRef<'_, T>

where T: Repr + Sync,