pub struct EmbeddingSimilarity;Expand description
Utility functions for vector embedding similarity.
Implementations§
Source§impl EmbeddingSimilarity
impl EmbeddingSimilarity
Sourcepub fn cosine(a: &[f64], b: &[f64]) -> f64
pub fn cosine(a: &[f64], b: &[f64]) -> f64
Cosine similarity between two vectors.
Returns 0.0 if either vector is the zero vector.
Sourcepub fn dot_product(a: &[f64], b: &[f64]) -> f64
pub fn dot_product(a: &[f64], b: &[f64]) -> f64
Raw dot product of two vectors.
Sourcepub fn euclidean(a: &[f64], b: &[f64]) -> f64
pub fn euclidean(a: &[f64], b: &[f64]) -> f64
Euclidean distance converted to a similarity score 1 / (1 + distance).
Sourcepub fn manhattan(a: &[f64], b: &[f64]) -> f64
pub fn manhattan(a: &[f64], b: &[f64]) -> f64
Manhattan (L1) distance converted to a similarity score 1 / (1 + distance).
Sourcepub fn chebyshev(a: &[f64], b: &[f64]) -> f64
pub fn chebyshev(a: &[f64], b: &[f64]) -> f64
Chebyshev (L∞) distance converted to a similarity score 1 / (1 + distance).
Sourcepub fn compute(a: &[f64], b: &[f64], metric: SimilarityMetric) -> f64
pub fn compute(a: &[f64], b: &[f64], metric: SimilarityMetric) -> f64
Compute the similarity between a and b using the given metric.
Sourcepub fn top_k(
query: &[f64],
corpus: &[Vec<f64>],
k: usize,
metric: SimilarityMetric,
) -> Vec<SimilarityResult>
pub fn top_k( query: &[f64], corpus: &[Vec<f64>], k: usize, metric: SimilarityMetric, ) -> Vec<SimilarityResult>
Return the top-k most similar vectors from corpus relative to query.
Results are sorted descending by score (most similar first).
If k exceeds corpus.len(), all entries are returned.
Auto Trait Implementations§
impl Freeze for EmbeddingSimilarity
impl RefUnwindSafe for EmbeddingSimilarity
impl Send for EmbeddingSimilarity
impl Sync for EmbeddingSimilarity
impl Unpin for EmbeddingSimilarity
impl UnsafeUnpin for EmbeddingSimilarity
impl UnwindSafe for EmbeddingSimilarity
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.