Struct PQCode 

pub struct PQCode<const M: usize, const NBITS: usize>
where
    [(); { _ }]:,
{
    pub codes: [[u8; { _ }]; M],
}

Encoded representation from Product Quantization.

Stores M centroid indices, each using ceil(NBITS/8) bytes (byte-aligned).

• M: number of subquantizers
• NBITS: bits per centroid index

Examples:

• PQCode<8, 8>: 8 subquantizers, 256 centroids each, 8 bytes total
• PQCode<16, 10>: 16 subquantizers, 1024 centroids each, 32 bytes total

Fields

codes: [[u8; { _ }]; M]

Raw byte storage: M * ceil(NBITS/8) bytes, stored as [[u8; B]; M]

Implementations

impl<const M: usize, const NBITS: usize> PQCode<M, NBITS>

where [(); { _ }]:,

pub const KSUB: usize

Number of centroids per subquantizer (2^NBITS)

pub const BYTES_PER_CODE: usize

Bytes per centroid index

pub const TOTAL_BYTES: usize

Total bytes for all M codes

pub fn new(codes: [[u8; { _ }]; M]) -> Self

Create a new PQCode from raw byte array

pub fn get(&self, m: usize) -> u32

Get centroid index at position m as u32

pub fn set(&mut self, m: usize, value: u32)

Set centroid index at position m

pub fn m(&self) -> usize

Number of subquantizers

pub fn zeros() -> Self

Create a zeroed PQCode

pub fn from_indices(indices: &[u32]) -> Self

Create from individual centroid indices

Trait Implementations

impl<const M: usize, const NBITS: usize> Clone for PQCode<M, NBITS>

where [(); { _ }]:,

fn clone(&self) -> PQCode<M, NBITS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const M: usize, const NBITS: usize> Debug for PQCode<M, NBITS>

where [(); { _ }]:,

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

Formats the value using the given formatter.

impl<const M: usize, const NBITS: usize> Display for PQCode<M, NBITS>

where [(); { _ }]:,

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

Formats the value using the given formatter.

impl<const M: usize, const NBITS: usize> Embedding for PQCode<M, NBITS>

where [(); { _ }]:,

type Scalar = u8

fn length() -> usize

fn as_slice(&self) -> &[Self::Scalar]

fn from_slice(data: &[Self::Scalar]) -> Self

fn zeros() -> Self

impl<const M: usize, const NBITS: usize> From<PQCode<M, NBITS>> for TensorProto

where [(); { _ }]:,

Available on crate feature proto only.

fn from(code: PQCode<M, NBITS>) -> Self

Converts to this type from the input type.

impl<const M: usize, const NBITS: usize> Hash for PQCode<M, NBITS>

where [(); { _ }]:,

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const M: usize, const NBITS: usize> PartialEq for PQCode<M, NBITS>

where [(); { _ }]:,

fn eq(&self, other: &PQCode<M, NBITS>) -> 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<const M: usize, const NBITS: usize> TryFrom<TensorProto> for PQCode<M, NBITS>

where [(); { _ }]:,

Available on crate feature proto only.

type Error = ProtoConversionError

The type returned in the event of a conversion error.

fn try_from(proto: TensorProto) -> Result<Self, Self::Error>

Performs the conversion.

impl<const M: usize, const NBITS: usize> Eq for PQCode<M, NBITS>

where [(); { _ }]:,

impl<const M: usize, const NBITS: usize> StructuralPartialEq for PQCode<M, NBITS>

where [(); { _ }]:,