Struct CompensatedIP 

pub struct CompensatedIP { /* private fields */ }

A DistanceFunction containing scaling parameters to enable distance the SquaredL2 distance function over CompensatedVectors belonging to the same quantization space.

Implementations

impl CompensatedIP

pub fn new(shift: &[f32], dim: usize) -> Self

Construct a new CompensatedIP with the given scaling factor and shift norm.

Trait Implementations

impl<A> AsFunctor<CompensatedIP> for SphericalQuantizer<A>

where A: Allocator,

fn as_functor(&self) -> CompensatedIP

impl Clone for CompensatedIP

fn clone(&self) -> CompensatedIP

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompensatedIP

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

Formats the value using the given formatter.

impl<A, const NBITS: usize> Target2<A, Result<MathematicalValue<f32>, UnequalLengths>, Slice<&[f32], Ref<'_, FullQueryMeta>>, VectorBase<NBITS, Unsigned, SlicePtr<'_, u8>, Ref<'_, DataMeta>>> for CompensatedIP

where A: Architecture, Unsigned: Representation<NBITS>, InnerProduct: for<'a> Target2<A, MathematicalResult<f32>, &'a [f32], BitSlice<'a, NBITS, Unsigned>>,

Compute the inner product between a full-precision query and a spherically quantized data vector.

Returns an error if the arguments have different lengths.

fn run( self, arch: A, x: FullQueryRef<'_>, y: DataRef<'_, NBITS>, ) -> MathematicalResult<f32>

Run the operation with the provided Architecture.

impl<A, const NBITS: usize> Target2<A, Result<MathematicalValue<f32>, UnequalLengths>, VectorBase<NBITS, Unsigned, SlicePtr<'_, u8>, Ref<'_, DataMeta>>, VectorBase<NBITS, Unsigned, SlicePtr<'_, u8>, Ref<'_, DataMeta>>> for CompensatedIP

where A: Architecture, Unsigned: Representation<NBITS>, InnerProduct: for<'a> Target2<A, MathematicalResult<u32>, BitSlice<'a, NBITS, Unsigned>, BitSlice<'a, NBITS, Unsigned>>,

Compute the inner product between the two compensated vectors.

Returns an error if the arguments have different lengths.

The value returned by this function is scaled properly, meaning that distances returned by this method are compatible with full-precision computations.

Validity

The results of this function are only meaningful if both x, y, and Self belong to the same quantizer.

fn run( self, arch: A, x: DataRef<'_, NBITS>, y: DataRef<'_, NBITS>, ) -> MathematicalResult<f32>

Run the operation with the provided Architecture.

impl<A, const Q: usize, const D: usize, Perm> Target2<A, Result<MathematicalValue<f32>, UnequalLengths>, VectorBase<Q, Unsigned, SlicePtr<'_, u8>, Ref<'_, QueryMeta>, Perm>, VectorBase<D, Unsigned, SlicePtr<'_, u8>, Ref<'_, DataMeta>>> for CompensatedIP

where A: Architecture, Unsigned: Representation<Q> + Representation<D>, Perm: PermutationStrategy<Q>, for<'a> InnerProduct: Target2<A, MathematicalResult<u32>, BitSlice<'a, Q, Unsigned, Perm>, BitSlice<'a, D, Unsigned>>,

fn run( self, arch: A, x: QueryRef<'_, Q, Perm>, y: DataRef<'_, D>, ) -> MathematicalResult<f32>

Run the operation with the provided Architecture.

impl<A, T, U> Target2<A, Result<f32, UnequalLengths>, T, U> for CompensatedIP

where A: Architecture, Self: Target2<A, MathematicalResult<f32>, T, U>,

A blanket implementation for applying the negating transformation

x -> -x

from MathematicalValue to f32 for inner product distance computations.

fn run(self, arch: A, x: T, y: U) -> Result<f32>

Run the operation with the provided Architecture.

impl Copy for CompensatedIP