Enum google_api_proto::google::firestore::v1::structured_query::find_nearest::DistanceMeasure

#[repr(i32)]
pub enum DistanceMeasure {
    Unspecified = 0,
    Euclidean = 1,
    Cosine = 2,
    DotProduct = 3,
}

The distance measure to use when comparing vectors.

Variants

Unspecified = 0

Should not be set.

Euclidean = 1

Measures the EUCLIDEAN distance between the vectors. See Euclidean to learn more. The resulting distance decreases the more similar two vectors are.

Cosine = 2

COSINE distance compares vectors based on the angle between them, which allows you to measure similarity that isn’t based on the vectors magnitude. We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See Cosine Similarity to learn more about COSINE similarity and COSINE distance. The resulting COSINE distance decreases the more similar two vectors are.

DotProduct = 3

Similar to cosine but is affected by the magnitude of the vectors. See Dot Product to learn more. The resulting distance increases the more similar two vectors are.

Implementations

impl DistanceMeasure

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of DistanceMeasure.

pub fn from_i32(value: i32) -> Option<DistanceMeasure>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a DistanceMeasure, or None if value is not a valid variant.

impl DistanceMeasure

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

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for DistanceMeasure

fn clone(&self) -> DistanceMeasure

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DistanceMeasure

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

Formats the value using the given formatter.

impl Default for DistanceMeasure

fn default() -> DistanceMeasure

Returns the “default value” for a type.

impl From<DistanceMeasure> for i32

fn from(value: DistanceMeasure) -> i32

Converts to this type from the input type.

impl Hash for DistanceMeasure

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 Ord for DistanceMeasure

fn cmp(&self, other: &DistanceMeasure) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for DistanceMeasure

fn eq(&self, other: &DistanceMeasure) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DistanceMeasure

fn partial_cmp(&self, other: &DistanceMeasure) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for DistanceMeasure

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<DistanceMeasure, UnknownEnumValue>

Performs the conversion.

impl Copy for DistanceMeasure

impl Eq for DistanceMeasure

impl StructuralPartialEq for DistanceMeasure