PQCode

Struct PQCode 

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

A compressed vector code from Product Quantization.

Each byte represents an index into the corresponding subspace codebook. For 256 centroids (default), this is one byte per segment.

Implementations§

Source§

impl PQCode

Source

pub fn new(codes: Vec<u8>, bits_per_code: u8) -> Self

Create a new PQ code from raw indices.

§Arguments
  • codes: Centroid indices, one per segment
  • bits_per_code: Number of bits per index (typically 8 for 256 centroids)
Source

pub fn num_segments(&self) -> usize

Get the number of segments.

Source

pub fn get(&self, segment: usize) -> Option<u8>

Get the code (centroid index) for a segment.

Source

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

Get all codes as a slice.

Source

pub fn to_bytes(&self) -> Vec<u8>

Convert to bytes for storage.

Source

pub fn from_bytes(bytes: &[u8], num_segments: usize, bits_per_code: u8) -> Self

Create from bytes.

§Arguments
  • bytes: Packed code bytes
  • num_segments: Number of segments (codes)
  • bits_per_code: Number of bits per code

Trait Implementations§

Source§

impl Clone for PQCode

Source§

fn clone(&self) -> PQCode

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 PQCode

Source§

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

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

impl PartialEq for PQCode

Source§

fn eq(&self, other: &PQCode) -> 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 Eq for PQCode

Source§

impl StructuralPartialEq for PQCode

Auto Trait Implementations§

§

impl Freeze for PQCode

§

impl RefUnwindSafe for PQCode

§

impl Send for PQCode

§

impl Sync for PQCode

§

impl Unpin for PQCode

§

impl UnwindSafe for PQCode

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more