Struct MathematicalValue 

pub struct MathematicalValue<T>(/* private fields */)
where
    T: Copy;

The DiskANN library uses f32 values to represent similarity scores, but distance functions can return either similarity-scores (those that are potentially transformed so that minimization yields higher similarity) and mathematical values (those that are computed from the mathematical definition of the operation.

Since those are currently mixed in the library with the more common use being a similarity-score, make the MathematicalValue the type to represent no transformation was performed.

Implementations

impl<T: Copy> MathematicalValue<T>

pub fn new(value: T) -> Self

pub fn into_inner(self) -> T

Trait Implementations

impl<T> Clone for MathematicalValue<T>

where T: Copy + Clone,

fn clone(&self) -> MathematicalValue<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for MathematicalValue<T>

where T: Copy + Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq for MathematicalValue<T>

where T: Copy + PartialEq,

fn eq(&self, other: &MathematicalValue<T>) -> 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<T> PartialOrd for MathematicalValue<T>

where T: Copy + PartialOrd,

fn partial_cmp(&self, other: &MathematicalValue<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PureDistanceFunction<&[f16], &[f16], MathematicalValue<f32>> for Cosine

fn evaluate(x: &[Half], y: &[Half]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f16], &[f16], MathematicalValue<f32>> for CosineNormalized

fn evaluate(x: &[Half], y: &[Half]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f16], &[f16], MathematicalValue<f32>> for FullL2

fn evaluate(x: &[Half], y: &[Half]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f16], &[f16], MathematicalValue<f32>> for InnerProduct

fn evaluate(x: &[Half], y: &[Half]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f16], &[f16], MathematicalValue<f32>> for SquaredL2

fn evaluate(x: &[Half], y: &[Half]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f16; N], &[f16; N], MathematicalValue<f32>> for Cosine

fn evaluate(x: &[Half; N], y: &[Half; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f16; N], &[f16; N], MathematicalValue<f32>> for CosineNormalized

fn evaluate(x: &[Half; N], y: &[Half; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f16; N], &[f16; N], MathematicalValue<f32>> for FullL2

fn evaluate(x: &[Half; N], y: &[Half; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f16; N], &[f16; N], MathematicalValue<f32>> for InnerProduct

fn evaluate(x: &[Half; N], y: &[Half; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f16; N], &[f16; N], MathematicalValue<f32>> for SquaredL2

fn evaluate(x: &[Half; N], y: &[Half; N]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f32], &[f16], MathematicalValue<f32>> for Cosine

fn evaluate(x: &[f32], y: &[Half]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f32], &[f16], MathematicalValue<f32>> for CosineNormalized

fn evaluate(x: &[f32], y: &[Half]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f32], &[f16], MathematicalValue<f32>> for FullL2

fn evaluate(x: &[f32], y: &[Half]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f32], &[f16], MathematicalValue<f32>> for InnerProduct

fn evaluate(x: &[f32], y: &[Half]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f32], &[f16], MathematicalValue<f32>> for SquaredL2

fn evaluate(x: &[f32], y: &[Half]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f32], &[f32], MathematicalValue<f32>> for Cosine

fn evaluate(x: &[f32], y: &[f32]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f32], &[f32], MathematicalValue<f32>> for CosineNormalized

fn evaluate(x: &[f32], y: &[f32]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f32], &[f32], MathematicalValue<f32>> for FullL2

fn evaluate(x: &[f32], y: &[f32]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f32], &[f32], MathematicalValue<f32>> for InnerProduct

fn evaluate(x: &[f32], y: &[f32]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[f32], &[f32], MathematicalValue<f32>> for SquaredL2

fn evaluate(x: &[f32], y: &[f32]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f32; N], &[f16; N], MathematicalValue<f32>> for Cosine

fn evaluate(x: &[f32; N], y: &[Half; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f32; N], &[f16; N], MathematicalValue<f32>> for CosineNormalized

fn evaluate(x: &[f32; N], y: &[Half; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f32; N], &[f16; N], MathematicalValue<f32>> for FullL2

fn evaluate(x: &[f32; N], y: &[Half; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f32; N], &[f16; N], MathematicalValue<f32>> for InnerProduct

fn evaluate(x: &[f32; N], y: &[Half; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f32; N], &[f16; N], MathematicalValue<f32>> for SquaredL2

fn evaluate(x: &[f32; N], y: &[Half; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f32; N], &[f32; N], MathematicalValue<f32>> for Cosine

fn evaluate(x: &[f32; N], y: &[f32; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f32; N], &[f32; N], MathematicalValue<f32>> for CosineNormalized

fn evaluate(x: &[f32; N], y: &[f32; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f32; N], &[f32; N], MathematicalValue<f32>> for FullL2

fn evaluate(x: &[f32; N], y: &[f32; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f32; N], &[f32; N], MathematicalValue<f32>> for InnerProduct

fn evaluate(x: &[f32; N], y: &[f32; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[f32; N], &[f32; N], MathematicalValue<f32>> for SquaredL2

fn evaluate(x: &[f32; N], y: &[f32; N]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[i8], &[i8], MathematicalValue<f32>> for Cosine

fn evaluate(x: &[i8], y: &[i8]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[i8], &[i8], MathematicalValue<f32>> for FullL2

fn evaluate(x: &[i8], y: &[i8]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[i8], &[i8], MathematicalValue<f32>> for InnerProduct

fn evaluate(x: &[i8], y: &[i8]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[i8], &[i8], MathematicalValue<f32>> for SquaredL2

fn evaluate(x: &[i8], y: &[i8]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[i8; N], &[i8; N], MathematicalValue<f32>> for Cosine

fn evaluate(x: &[i8; N], y: &[i8; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[i8; N], &[i8; N], MathematicalValue<f32>> for FullL2

fn evaluate(x: &[i8; N], y: &[i8; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[i8; N], &[i8; N], MathematicalValue<f32>> for InnerProduct

fn evaluate(x: &[i8; N], y: &[i8; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[i8; N], &[i8; N], MathematicalValue<f32>> for SquaredL2

fn evaluate(x: &[i8; N], y: &[i8; N]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[u8], &[u8], MathematicalValue<f32>> for Cosine

fn evaluate(x: &[u8], y: &[u8]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[u8], &[u8], MathematicalValue<f32>> for FullL2

fn evaluate(x: &[u8], y: &[u8]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[u8], &[u8], MathematicalValue<f32>> for InnerProduct

fn evaluate(x: &[u8], y: &[u8]) -> MathematicalValue<f32>

impl PureDistanceFunction<&[u8], &[u8], MathematicalValue<f32>> for SquaredL2

fn evaluate(x: &[u8], y: &[u8]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[u8; N], &[u8; N], MathematicalValue<f32>> for Cosine

fn evaluate(x: &[u8; N], y: &[u8; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[u8; N], &[u8; N], MathematicalValue<f32>> for FullL2

fn evaluate(x: &[u8; N], y: &[u8; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[u8; N], &[u8; N], MathematicalValue<f32>> for InnerProduct

fn evaluate(x: &[u8; N], y: &[u8; N]) -> MathematicalValue<f32>

impl<const N: usize> PureDistanceFunction<&[u8; N], &[u8; N], MathematicalValue<f32>> for SquaredL2

fn evaluate(x: &[u8; N], y: &[u8; N]) -> MathematicalValue<f32>

impl<T> Copy for MathematicalValue<T>

where T: Copy + Copy,

impl<T> StructuralPartialEq for MathematicalValue<T>

where T: Copy,