pub struct CosineDistance;Expand description
Cosine similarity-based pseudo-distance on ℝⁿ.
d_cos(x, y) = 1 − cos(θ) = 1 − (⟨x,y⟩ / (‖x‖₂ · ‖y‖₂))
Note: this is not a true metric (triangle inequality may fail), but it is widely used in information retrieval and machine-learning contexts.
Implementations§
Trait Implementations§
Source§impl Clone for CosineDistance
impl Clone for CosineDistance
Source§fn clone(&self) -> CosineDistance
fn clone(&self) -> CosineDistance
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for CosineDistance
impl Debug for CosineDistance
Source§impl Default for CosineDistance
impl Default for CosineDistance
Source§fn default() -> CosineDistance
fn default() -> CosineDistance
Returns the “default value” for a type. Read more
impl Copy for CosineDistance
Auto Trait Implementations§
impl Freeze for CosineDistance
impl RefUnwindSafe for CosineDistance
impl Send for CosineDistance
impl Sync for CosineDistance
impl Unpin for CosineDistance
impl UnsafeUnpin for CosineDistance
impl UnwindSafe for CosineDistance
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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.