Enum BinaryDistanceMetric 

pub enum BinaryDistanceMetric {
    Hamming,
    HammingNormalized,
    Jaccard,
}

Distance metric for comparing binary vectors.

Variants

Hamming

Hamming distance (count of differing bits).

HammingNormalized

Normalized Hamming distance (Hamming / dimension), range [0, 1].

Jaccard

Jaccard distance (1 - Jaccard similarity), range [0, 1].

Implementations

impl BinaryDistanceMetric

pub fn calculate(&self, a: &BinaryEmbedding, b: &BinaryEmbedding) -> f32

Calculate the distance between two binary embeddings using this metric.

Panics

Debug-panics if embeddings have different dimensions.

Trait Implementations

impl Clone for BinaryDistanceMetric

fn clone(&self) -> BinaryDistanceMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryDistanceMetric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BinaryDistanceMetric

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BinaryDistanceMetric

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for BinaryDistanceMetric

impl Eq for BinaryDistanceMetric

impl StructuralPartialEq for BinaryDistanceMetric