Struct MetricKind

#[repr(transparent)]
pub struct MetricKind {
    pub repr: i32,
}

The metric kind used to differentiate built-in distance functions.

Fields

repr: i32

Implementations

impl MetricKind

pub const Unknown: Self

pub const IP: Self

The Inner Product metric, defined as IP = 1 - sum(a[i] * b[i]).

pub const L2sq: Self

The squared Euclidean Distance metric, defined as L2 = sum((a[i] - b[i])^2).

pub const Cos: Self

The Cosine Similarity metric, defined as Cos = 1 - sum(a[i] * b[i]) / (sqrt(sum(a[i]^2) * sqrt(sum(b[i]^2))).

pub const Pearson: Self

The Pearson Correlation metric.

pub const Haversine: Self

The Haversine (Great Circle) Distance metric.

pub const Divergence: Self

The Jensen Shannon Divergence metric.

pub const Hamming: Self

The bit-level Hamming Distance metric, defined as the number of differing bits.

pub const Tanimoto: Self

The bit-level Tanimoto (Jaccard) metric, defined as the number of intersecting bits divided by the number of union bits.

pub const Sorensen: Self

The bit-level Sorensen metric.

Trait Implementations

impl Clone for MetricKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricKind

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

Formats the value using the given formatter.

impl ExternType for MetricKind

type Kind = Trivial

Either cxx::kind::Opaque or cxx::kind::Trivial.

type Id

A type-level representation of the type’s C++ namespace and type name.

impl PartialEq for MetricKind

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

impl Eq for MetricKind

impl StructuralPartialEq for MetricKind