Skip to main content

CompressedVector

Struct CompressedVector 

Source
pub struct CompressedVector { /* private fields */ }
Expand description

Immutable per-vector compressed payload. Mirrors Python CompressedVector.

§Invariants

  • indices.len() == dimension as usize
  • bit_width ∈ {2, 4, 8}
  • If residual.is_some(), residual.len() == dimension as usize * 2

Implementations§

Source§

impl CompressedVector

Source

pub fn new( indices: Box<[u8]>, residual: Option<Box<[u8]>>, config_hash: ConfigHash, dimension: u32, bit_width: u8, ) -> Result<Self, CodecError>

Validated constructor. Mirrors Python CompressedVector.__post_init__.

§Errors
Source

pub fn indices(&self) -> &[u8]

Raw index bytes — one byte per dimension (upper bits zero for bit_width < 8).

Source

pub fn residual(&self) -> Option<&[u8]>

Optional f16 LE residual bytes — 2 * dimension bytes when present.

Source

pub const fn config_hash(&self) -> &ConfigHash

The config_hash of the CodecConfig used to compress this vector.

Source

pub const fn dimension(&self) -> u32

Number of dimensions (= indices.len()).

Source

pub const fn bit_width(&self) -> u8

Bit width used during compression.

Source

pub fn has_residual(&self) -> bool

true when a residual buffer is present.

Source

pub fn size_bytes(&self) -> usize

Python-parity size estimate: ceil(dim * bit_width / 8) + residual.len().

This is the packed on-disk footprint, not the in-memory footprint (indices are stored unpacked, 1 byte/dim, until Phase 16).

Trait Implementations§

Source§

impl Clone for CompressedVector

Source§

fn clone(&self) -> CompressedVector

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 CompressedVector

Source§

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

Formats the value using the given formatter. Read more

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