Skip to main content

CompressionPolicy

Enum CompressionPolicy 

Source
pub enum CompressionPolicy {
    Compress,
    Passthrough,
    Fp16,
}
Expand description

Determines how vectors are stored in a Corpus.

The policy is set at construction and cannot be changed after the first insert call.

Variants§

§

Compress

Full codec pipeline: rotate → scalar quantize → optional FP16 residual.

Requires a trained Codebook and a CodecConfig. Produces StorageTag::U8 output.

§

Passthrough

Store raw f32 bytes with no transformation (1× compression ratio).

The four bytes of each f32 are stored in little-endian order inside the indices field of a CompressedVector. Produces StorageTag::F32 output.

§

Fp16

Cast each f32 to a 16-bit float and store 2 bytes per dimension in little-endian order (2× compression ratio).

Precision loss is bounded by the f16 range; max |error| is typically below 1e-2 for normalised embedding values. Produces StorageTag::F16 output.

Implementations§

Source§

impl CompressionPolicy

Source

pub const fn requires_codec(&self) -> bool

Returns true for policies that run the full codec pipeline.

Only CompressionPolicy::Compress requires a trained codebook; the other policies bypass the codec entirely.

Source

pub const fn storage_tag(&self) -> StorageTag

Returns the StorageTag that describes the byte layout used by this policy.

Trait Implementations§

Source§

impl Clone for CompressionPolicy

Source§

fn clone(&self) -> CompressionPolicy

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 Debug for CompressionPolicy

Source§

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

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

impl Hash for CompressionPolicy

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CompressionPolicy

Source§

fn eq(&self, other: &CompressionPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for CompressionPolicy

Source§

impl Eq for CompressionPolicy

Source§

impl StructuralPartialEq for CompressionPolicy

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> 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, 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> Same for T

Source§

type Output = T

Should always be Self
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> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,