Struct MinMaxMeta 

pub struct MinMaxMeta<const NBITS: usize> { /* private fields */ }

Metadata for MinMax quantized multi-vectors.

Stores the intrinsic dimension (output dimension after transform) which is needed to interpret each row of the quantized data. The row stride in bytes is computed as [Data::<NBITS>::canonical_bytes(intrinsic_dim)].

Implementations

impl<const NBITS: usize> MinMaxMeta<NBITS>

where Unsigned: Representation<NBITS>,

pub fn new(nrows: usize, intrinsic_dim: usize) -> Self

Creates new MinMax metadata with the given number of rows and intrinsic dimension.

pub fn intrinsic_dim(&self) -> usize

Returns the intrinsic_dim

pub fn ncols(&self) -> usize

Returns the number of bytes from a canonical repr of a minmax quantized vector, see minmax::Data::canonical_bytes

Trait Implementations

impl<const NBITS: usize> Clone for MinMaxMeta<NBITS>

fn clone(&self) -> MinMaxMeta<NBITS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const NBITS: usize> Debug for MinMaxMeta<NBITS>

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

Formats the value using the given formatter.

impl<const NBITS: usize> NewMut<u8> for MinMaxMeta<NBITS>

where Unsigned: Representation<NBITS>,

type Error = SliceError

Errors that can occur when initializing.

fn new_mut(self, slice: &mut [u8]) -> Result<MatMut<'_, Self>, Self::Error>

Create a new MatMut over slice.

impl<const NBITS: usize> NewOwned<Defaulted> for MinMaxMeta<NBITS>

where Unsigned: Representation<NBITS>,

type Error = Infallible

Errors that can occur when initializing.

fn new_owned(self, _: Defaulted) -> Result<Mat<Self>, Self::Error>

Create a new Mat initialized with init.

impl<const NBITS: usize> NewRef<u8> for MinMaxMeta<NBITS>

where Unsigned: Representation<NBITS>,

type Error = SliceError

Errors that can occur when initializing.

fn new_ref(self, slice: &[u8]) -> Result<MatRef<'_, Self>, Self::Error>

Create a new MatRef over slice.

impl<const NBITS: usize> Repr for MinMaxMeta<NBITS>

where Unsigned: Representation<NBITS>,

fn layout(&self) -> Result<Layout, LayoutError>

Returns Layout for for allocating crate::minmax::Data

Safety

• crate::minmax::MinMaxCompensation does not require alignment since it is always accessed by copying bytes first before casting.

unsafe fn get_row<'a>(self, ptr: NonNull<u8>, i: usize) -> Self::Row<'a>

Returns an immutable reference to the i-th row.

Safety

• The original pointer must point to a valid allocation of at least std::mem::size_of::<u8>() * self.nrows() * self.ncols() bytes for lifetime 'a.
• i must be less than self.nrows.

type Row<'a> = VectorBase<NBITS, Unsigned, SlicePtr<'a, u8>, Ref<'a, MinMaxCompensation>>

Immutable row reference type.

fn nrows(&self) -> usize

Returns the number of rows in the matrix.

impl<const NBITS: usize> ReprMut for MinMaxMeta<NBITS>

where Unsigned: Representation<NBITS>,

unsafe fn get_row_mut<'a>(self, ptr: NonNull<u8>, i: usize) -> Self::RowMut<'a>

Returns a mutable reference to the i-th row.

Safety

• The original pointer must point to a valid allocation of at least std::mem::size_of::<u8>() * self.bytes() bytes for lifetime 'a.
• i must be less than self.nrows.
• Caller must make sure they have exclusive access to the row

type RowMut<'a> = VectorBase<NBITS, Unsigned, MutSlicePtr<'a, u8>, Mut<'a, MinMaxCompensation>>

Mutable row reference type.

impl<const NBITS: usize> ReprOwned for MinMaxMeta<NBITS>

where Unsigned: Representation<NBITS>,

unsafe fn drop(self, ptr: NonNull<u8>)

Deallocates the memory pointed to by ptr.

Safety:

• The caller guarantees that ptr was allocated with the correct layout.

impl<const NBITS: usize> Copy for MinMaxMeta<NBITS>