Skip to main content

Recompressor

Struct Recompressor 

Source
pub struct Recompressor;
Expand description

Recompression utilities for MinMax quantized vectors.

This struct provides functionality to further compress MinMax quantized vectors from a source bitrate N to a target bitrate M for N > M.

§Notes

  • Currently this API only supports the following conversions: 8 -> 4, 8 -> 2, 4 -> 2

§Example

use std::num::NonZeroUsize;
use diskann_quantization::algorithms::{Transform, transforms::NullTransform};
use diskann_quantization::minmax::{Data, MinMaxQuantizer, Recompressor};
use diskann_quantization::num::Positive;
use diskann_quantization::CompressInto;
use diskann_utils::{Reborrow, ReborrowMut};

// Create a quantizer and compress an f32 vector to 8-bit
let vector = vec![0.1, -0.5, 0.8, -0.2];
let quantizer = MinMaxQuantizer::new(
    Transform::Null(NullTransform::new(NonZeroUsize::new(4).unwrap())),
    Positive::new(1.0).unwrap(),
);

let mut encoded_8 = Data::<8>::new_boxed(4);
quantizer.compress_into(vector.as_slice(), encoded_8.reborrow_mut()).unwrap();

// Recompress from 8-bit to 4-bit
let mut encoded_4 = Data::<4>::new_boxed(4);
Recompressor.compress_into(encoded_8.reborrow(), encoded_4.reborrow_mut()).unwrap();

Trait Implementations§

Source§

impl Clone for Recompressor

Source§

fn clone(&self) -> Recompressor

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, 'b> CompressInto<VectorBase<4, Unsigned, SlicePtr<'a, u8>, Ref<'a, MinMaxCompensation>>, VectorBase<2, Unsigned, MutSlicePtr<'b, u8>, Mut<'b, MinMaxCompensation>>> for Recompressor

Source§

type Error = RecompressError

Errors that may occur during compression.
Source§

type Output = ()

An output type resulting from compression.
Source§

fn compress_into( &self, from: DataRef<'a, 4>, to: DataMutRef<'b, 2>, ) -> Result<(), Self::Error>

Compress the data in From into To. Read more
Source§

impl<'a, 'b> CompressInto<VectorBase<8, Unsigned, SlicePtr<'a, u8>, Ref<'a, MinMaxCompensation>>, VectorBase<2, Unsigned, MutSlicePtr<'b, u8>, Mut<'b, MinMaxCompensation>>> for Recompressor

Source§

type Error = RecompressError

Errors that may occur during compression.
Source§

type Output = ()

An output type resulting from compression.
Source§

fn compress_into( &self, from: DataRef<'a, 8>, to: DataMutRef<'b, 2>, ) -> Result<(), Self::Error>

Compress the data in From into To. Read more
Source§

impl<'a, 'b> CompressInto<VectorBase<8, Unsigned, SlicePtr<'a, u8>, Ref<'a, MinMaxCompensation>>, VectorBase<4, Unsigned, MutSlicePtr<'b, u8>, Mut<'b, MinMaxCompensation>>> for Recompressor

Source§

type Error = RecompressError

Errors that may occur during compression.
Source§

type Output = ()

An output type resulting from compression.
Source§

fn compress_into( &self, from: DataRef<'a, 8>, to: DataMutRef<'b, 4>, ) -> Result<(), Self::Error>

Compress the data in From into To. Read more
Source§

impl Debug for Recompressor

Source§

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

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

impl Copy for Recompressor

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