Enum BinaryDistanceMetric 

#[non_exhaustive]
pub enum BinaryDistanceMetric {
    Hamming,
    Jaccard,
}

Binary vector distance metric supported by pgvector.

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.

Hamming

Hamming distance (number of differing bits).

Operator: <~>

Jaccard

Jaccard distance (1 - Jaccard index).

Operator: <%>

Implementations

impl BinaryDistanceMetric

pub fn operator(&self) -> &'static str

Get the PostgreSQL operator for this metric.

pub fn ops_class(&self) -> &'static str

Get the operator class name for index creation.

pub fn name(&self) -> &'static str

Get a human-readable name for this metric.

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 Display for BinaryDistanceMetric

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

Formats the value using the given formatter.

impl Hash for BinaryDistanceMetric

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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