Skip to main content

MatMut

Struct MatMut 

Source
pub struct MatMut<'a, T: ReprMut> { /* private fields */ }
Expand description

A mutable borrowed view of a matrix.

Provides read-write access to matrix data without ownership.

§Type Parameter

  • T: A ReprMut implementation defining the row layout.

§Access

Implementations§

Source§

impl<'a, T: ReprMut> MatMut<'a, T>

Source

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

Construct a new MatMut over data.

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 get_row_mut(&mut self, i: usize) -> Option<T::RowMut<'_>>

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

Source

pub fn as_view(&self) -> MatRef<'_, T>

Reborrows as an immutable MatRef.

Source

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

Returns an iterator over immutable row references.

Source

pub fn rows_mut(&mut self) -> RowsMut<'_, T>

Returns an iterator over mutable row references.

Source

pub fn to_owned(&self) -> Mat<T>
where T: NewCloned,

Return a Mat with the same contents as self.

Source

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

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

§Safety

Argument ptr must point to memory compatible with Repr::layout.

Source

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

Return the base pointer for the MatMut.

Source§

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

Source

pub fn vector_dim(&self) -> usize

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

Trait Implementations§

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

Source§

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().
Source§

type Error = InputContainsNaN

Errors that may occur during compression.
Source§

type Output = ()

An output type resulting from compression.
Source§

impl<'a, T: Debug + ReprMut> Debug for MatMut<'a, T>

Source§

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

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

impl<'this, 'a, T: ReprMut> Reborrow<'this> for MatMut<'a, T>

Source§

type Target = MatRef<'this, T>

Source§

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

Borrow self into a generalized reference type and reborrow
Source§

impl<'this, 'a, T: ReprMut> ReborrowMut<'this> for MatMut<'a, T>

Source§

type Target = MatMut<'this, T>

Source§

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

Mutably borrow self into a generalized reference type and reborrow.
Source§

impl<T> Send for MatMut<'_, T>
where T: ReprMut + Send,

Source§

impl<T> Sync for MatMut<'_, T>
where T: ReprMut + Sync,

Auto Trait Implementations§

§

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

§

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

§

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

§

impl<'a, T> !UnwindSafe for MatMut<'a, T>

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, 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> AsyncFriendly for T
where T: Send + Sync + 'static,