Struct CompensatedCosine 

pub struct CompensatedCosine { /* private fields */ }

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

This distance function works by assuming input vectors were normalized prior to compression and therefore cosine may be computed by delegating to inner product computations. The crate::spherical::SphericalQuantizer will ensure this pre-normalization when constructed with SupportedMetric::Cosine.

Implementations

impl CompensatedCosine

pub fn new(inner: CompensatedIP) -> Self

Construct a new CompensatedCosine around the CompensatedIP.

Trait Implementations

impl<A> AsFunctor<CompensatedCosine> for SphericalQuantizer<A>

where A: Allocator,

fn as_functor(&self) -> CompensatedCosine

impl Clone for CompensatedCosine

fn clone(&self) -> CompensatedCosine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompensatedCosine

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

Formats the value using the given formatter.

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

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

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

Run the operation with the provided Architecture.

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

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

A blanket implementation for applying the transformation

x -> 1-x

from MathematicalValue to f32 for cosine distance computations.

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

Run the operation with the provided Architecture.

impl Copy for CompensatedCosine