Struct TurboQuantPackedCodes 

pub struct TurboQuantPackedCodes { /* private fields */ }

Row-major packed TurboQuant coordinate codes.

Implementations

impl TurboQuantPackedCodes

pub fn new( bit_width: TurboQuantBitWidth, dimensions: usize, rows: usize, ) -> TurboQuantCodecResult<Self>

Allocate zero-filled packed-code storage.

Errors

Returns an error when dimensions are invalid or the computed byte size overflows usize.

pub fn from_bytes( bit_width: TurboQuantBitWidth, dimensions: usize, rows: usize, bytes: Vec<u8>, ) -> TurboQuantCodecResult<Self>

Build packed-code storage from existing bytes.

Errors

Returns an error when dimensions are invalid, the computed byte size overflows usize, or bytes.len() does not match the expected shape.

pub const fn bit_width(&self) -> TurboQuantBitWidth

Return the bit width used by the packed codes.

pub const fn dimensions(&self) -> usize

Return the number of dimensions encoded in each row.

pub const fn rows(&self) -> usize

Return the number of encoded rows.

pub const fn bytes_per_row(&self) -> usize

Return the byte stride for one row, including any trailing padding bits.

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

Return the packed backing bytes.

pub fn into_bytes(self) -> Vec<u8>

Consume this storage and return the packed backing bytes.

pub fn estimated_bytes(&self) -> usize

Return the packed-code byte footprint.

pub fn resize_rows(&mut self, rows: usize) -> TurboQuantCodecResult<()>

Resize the row count while preserving existing packed rows.

Newly added rows are zero-filled. Shrinking drops trailing rows.

Errors

Returns an error when the computed byte size overflows usize.

pub fn read(&self, row: usize, dimension: usize) -> TurboQuantCodecResult<u8>

Read one packed coordinate code.

Errors

Returns bounds errors when row or dimension is outside the packed matrix.

pub fn write( &mut self, row: usize, dimension: usize, code: u8, ) -> TurboQuantCodecResult<()>

Write one packed coordinate code.

Errors

Returns bounds errors when row or dimension is outside the packed matrix, and TurboQuantCodecError::InvalidCode when code exceeds this storage’s bit width.

Trait Implementations

impl Clone for TurboQuantPackedCodes

fn clone(&self) -> TurboQuantPackedCodes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TurboQuantPackedCodes

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

Formats the value using the given formatter.

impl Eq for TurboQuantPackedCodes

impl PartialEq for TurboQuantPackedCodes

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for TurboQuantPackedCodes