Enum SimilarityMetric 

#[non_exhaustive]
pub enum SimilarityMetric {
    Cosine,
    Dot,
    L2,
}

Canonical vector distance/similarity metrics.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Cosine

Cosine similarity.

Dot

Dot product.

L2

Euclidean L2 distance.

Trait Implementations

impl Clone for SimilarityMetric

fn clone(&self) -> SimilarityMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SimilarityMetric

impl Debug for SimilarityMetric

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

Formats the value using the given formatter.

impl Default for SimilarityMetric

fn default() -> SimilarityMetric

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SimilarityMetric

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SimilarityMetric

impl PartialEq for SimilarityMetric

fn eq(&self, other: &SimilarityMetric) -> 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 Serialize for SimilarityMetric

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SimilarityMetric