Struct Impl 

pub struct Impl<const NBITS: usize, A = GlobalAllocator>
where
    A: Allocator,
{ /* private fields */ }

Implementation for Quantizer specializing on the number of bits used for data compression.

Implementations

impl<const NBITS: usize, A: Allocator> Impl<NBITS, A>

pub fn new(quantizer: SphericalQuantizer<A>) -> Result<Self, AllocatorError>

where Self: Constructible<A>,

Construct a new plan around quantizer providing distance computers for metric.

pub fn quantizer(&self) -> &SphericalQuantizer<A>

Return the underlying SphericalQuantizer.

pub fn supports(layout: QueryLayout) -> bool

Return true if this plan supports layout for query computers.

Otherwise, return false.

Trait Implementations

impl<const NBITS: usize, A> Constructible<A> for Impl<NBITS, A>

where A: Allocator, AsData<NBITS>: FromOpaque, SphericalQuantizer<A>: Dispatchable<AsData<NBITS>, NBITS>,

fn dispatch_distance( quantizer: &SphericalQuantizer<A>, ) -> Result<Poly<dyn DynDistanceComputer, A>, AllocatorError>

impl<A, B> Quantizer<B> for Impl<1, A>

where A: Allocator + RefUnwindSafe + Send + Sync + 'static, B: Allocator + UnwindSafe + Send + Sync + 'static,

fn nbits(&self) -> usize

The effective number of bits in the encoding.

fn dim(&self) -> usize

The effective dimensionality of each compressed vector.

fn full_dim(&self) -> usize

The dimensionality of the full-precision input vectors.

fn bytes(&self) -> usize

The number of bytes occupied by each compressed vector.

fn distance_computer( &self, allocator: B, ) -> Result<DistanceComputer<B>, AllocatorError>

Return a distance computer capable on operating on validly initialized Opaque slices of length Self::bytes.

fn distance_computer_ref(&self) -> &dyn DynDistanceComputer

Return a scoped distance computer capable on operating on validly initialized Opaque slices of length Self::bytes.

fn query_computer( &self, layout: QueryLayout, allocator: B, ) -> Result<DistanceComputer<B>, DistanceComputerError>

A stand alone distance computer specialized for the specified query layout.

fn query_buffer_description( &self, layout: QueryLayout, ) -> Result<QueryBufferDescription, UnsupportedQueryLayout>

Return the number of bytes and alignment of a buffer used to contain a compressed query with the provided layout.

fn compress_query( &self, x: &[f32], layout: QueryLayout, allow_rescale: bool, buffer: OpaqueMut<'_>, scratch: ScopedAllocator<'_>, ) -> Result<(), QueryCompressionError>

Compress the query using the specified layout into buffer.

fn fused_query_computer( &self, x: &[f32], layout: QueryLayout, allow_rescale: bool, allocator: B, scratch: ScopedAllocator<'_>, ) -> Result<QueryComputer<B>, QueryComputerError>

Return a query for the argument x capable on operating on validly initialized Opaque slices of length Self::bytes.

fn is_supported(&self, layout: QueryLayout) -> bool

Return whether or not this plan supports the given QueryLayout.

fn compress( &self, x: &[f32], into: OpaqueMut<'_>, scratch: ScopedAllocator<'_>, ) -> Result<(), CompressionError>

Compress the vector x into the opaque slice.

fn metric(&self) -> SupportedMetric

Return the metric this plan was created with.

fn try_clone_into( &self, allocator: B, ) -> Result<Poly<dyn Quantizer<B>, B>, AllocatorError>

Clone the backing object.

fn serialize(&self, allocator: B) -> Result<Poly<[u8], B>, AllocatorError>

Available on crate feature flatbuffers only.

Serialize self into a flatbuffer, returning the flatbuffer. The function try_deserialize should undo this operation.

impl<A, B> Quantizer<B> for Impl<2, A>

where A: Allocator + RefUnwindSafe + Send + Sync + 'static, B: Allocator + UnwindSafe + Send + Sync + 'static,

fn nbits(&self) -> usize

The effective number of bits in the encoding.

fn dim(&self) -> usize

The effective dimensionality of each compressed vector.

fn full_dim(&self) -> usize

The dimensionality of the full-precision input vectors.

fn bytes(&self) -> usize

The number of bytes occupied by each compressed vector.

fn distance_computer( &self, allocator: B, ) -> Result<DistanceComputer<B>, AllocatorError>

Return a distance computer capable on operating on validly initialized Opaque slices of length Self::bytes.

fn distance_computer_ref(&self) -> &dyn DynDistanceComputer

Return a scoped distance computer capable on operating on validly initialized Opaque slices of length Self::bytes.

fn query_computer( &self, layout: QueryLayout, allocator: B, ) -> Result<DistanceComputer<B>, DistanceComputerError>

A stand alone distance computer specialized for the specified query layout.

fn query_buffer_description( &self, layout: QueryLayout, ) -> Result<QueryBufferDescription, UnsupportedQueryLayout>

Return the number of bytes and alignment of a buffer used to contain a compressed query with the provided layout.

fn compress_query( &self, x: &[f32], layout: QueryLayout, allow_rescale: bool, buffer: OpaqueMut<'_>, scratch: ScopedAllocator<'_>, ) -> Result<(), QueryCompressionError>

Compress the query using the specified layout into buffer.

fn fused_query_computer( &self, x: &[f32], layout: QueryLayout, allow_rescale: bool, allocator: B, scratch: ScopedAllocator<'_>, ) -> Result<QueryComputer<B>, QueryComputerError>

Return a query for the argument x capable on operating on validly initialized Opaque slices of length Self::bytes.

fn is_supported(&self, layout: QueryLayout) -> bool

Return whether or not this plan supports the given QueryLayout.

fn compress( &self, x: &[f32], into: OpaqueMut<'_>, scratch: ScopedAllocator<'_>, ) -> Result<(), CompressionError>

Compress the vector x into the opaque slice.

fn metric(&self) -> SupportedMetric

Return the metric this plan was created with.

fn try_clone_into( &self, allocator: B, ) -> Result<Poly<dyn Quantizer<B>, B>, AllocatorError>

Clone the backing object.

fn serialize(&self, allocator: B) -> Result<Poly<[u8], B>, AllocatorError>

Available on crate feature flatbuffers only.

Serialize self into a flatbuffer, returning the flatbuffer. The function try_deserialize should undo this operation.

impl<A, B> Quantizer<B> for Impl<4, A>

where A: Allocator + RefUnwindSafe + Send + Sync + 'static, B: Allocator + UnwindSafe + Send + Sync + 'static,

fn nbits(&self) -> usize

The effective number of bits in the encoding.

fn dim(&self) -> usize

The effective dimensionality of each compressed vector.

fn full_dim(&self) -> usize

The dimensionality of the full-precision input vectors.

fn bytes(&self) -> usize

The number of bytes occupied by each compressed vector.

fn distance_computer( &self, allocator: B, ) -> Result<DistanceComputer<B>, AllocatorError>

Return a distance computer capable on operating on validly initialized Opaque slices of length Self::bytes.

fn distance_computer_ref(&self) -> &dyn DynDistanceComputer

Return a scoped distance computer capable on operating on validly initialized Opaque slices of length Self::bytes.

fn query_computer( &self, layout: QueryLayout, allocator: B, ) -> Result<DistanceComputer<B>, DistanceComputerError>

A stand alone distance computer specialized for the specified query layout.

fn query_buffer_description( &self, layout: QueryLayout, ) -> Result<QueryBufferDescription, UnsupportedQueryLayout>

Return the number of bytes and alignment of a buffer used to contain a compressed query with the provided layout.

fn compress_query( &self, x: &[f32], layout: QueryLayout, allow_rescale: bool, buffer: OpaqueMut<'_>, scratch: ScopedAllocator<'_>, ) -> Result<(), QueryCompressionError>

Compress the query using the specified layout into buffer.

fn fused_query_computer( &self, x: &[f32], layout: QueryLayout, allow_rescale: bool, allocator: B, scratch: ScopedAllocator<'_>, ) -> Result<QueryComputer<B>, QueryComputerError>

Return a query for the argument x capable on operating on validly initialized Opaque slices of length Self::bytes.

fn is_supported(&self, layout: QueryLayout) -> bool

Return whether or not this plan supports the given QueryLayout.

fn compress( &self, x: &[f32], into: OpaqueMut<'_>, scratch: ScopedAllocator<'_>, ) -> Result<(), CompressionError>

Compress the vector x into the opaque slice.

fn metric(&self) -> SupportedMetric

Return the metric this plan was created with.

fn try_clone_into( &self, allocator: B, ) -> Result<Poly<dyn Quantizer<B>, B>, AllocatorError>

Clone the backing object.

fn serialize(&self, allocator: B) -> Result<Poly<[u8], B>, AllocatorError>

Available on crate feature flatbuffers only.

Serialize self into a flatbuffer, returning the flatbuffer. The function try_deserialize should undo this operation.

impl<A, B> Quantizer<B> for Impl<8, A>

where A: Allocator + RefUnwindSafe + Send + Sync + 'static, B: Allocator + UnwindSafe + Send + Sync + 'static,

fn nbits(&self) -> usize

The effective number of bits in the encoding.

fn dim(&self) -> usize

The effective dimensionality of each compressed vector.

fn full_dim(&self) -> usize

The dimensionality of the full-precision input vectors.

fn bytes(&self) -> usize

The number of bytes occupied by each compressed vector.

fn distance_computer( &self, allocator: B, ) -> Result<DistanceComputer<B>, AllocatorError>

Return a distance computer capable on operating on validly initialized Opaque slices of length Self::bytes.

fn distance_computer_ref(&self) -> &dyn DynDistanceComputer

Return a scoped distance computer capable on operating on validly initialized Opaque slices of length Self::bytes.

fn query_computer( &self, layout: QueryLayout, allocator: B, ) -> Result<DistanceComputer<B>, DistanceComputerError>

A stand alone distance computer specialized for the specified query layout.

fn query_buffer_description( &self, layout: QueryLayout, ) -> Result<QueryBufferDescription, UnsupportedQueryLayout>

Return the number of bytes and alignment of a buffer used to contain a compressed query with the provided layout.

fn compress_query( &self, x: &[f32], layout: QueryLayout, allow_rescale: bool, buffer: OpaqueMut<'_>, scratch: ScopedAllocator<'_>, ) -> Result<(), QueryCompressionError>

Compress the query using the specified layout into buffer.

fn fused_query_computer( &self, x: &[f32], layout: QueryLayout, allow_rescale: bool, allocator: B, scratch: ScopedAllocator<'_>, ) -> Result<QueryComputer<B>, QueryComputerError>

Return a query for the argument x capable on operating on validly initialized Opaque slices of length Self::bytes.

fn is_supported(&self, layout: QueryLayout) -> bool

Return whether or not this plan supports the given QueryLayout.

fn compress( &self, x: &[f32], into: OpaqueMut<'_>, scratch: ScopedAllocator<'_>, ) -> Result<(), CompressionError>

Compress the vector x into the opaque slice.

fn metric(&self) -> SupportedMetric

Return the metric this plan was created with.

fn try_clone_into( &self, allocator: B, ) -> Result<Poly<dyn Quantizer<B>, B>, AllocatorError>

Clone the backing object.

fn serialize(&self, allocator: B) -> Result<Poly<[u8], B>, AllocatorError>

Available on crate feature flatbuffers only.

Serialize self into a flatbuffer, returning the flatbuffer. The function try_deserialize should undo this operation.