pub struct DistanceFunction(pub String);Expand description
How similarity between two vectors is measured. Open value wrapper, as
IndexKind.
Tuple Fields§
§0: StringImplementations§
Source§impl DistanceFunction
impl DistanceFunction
pub const COSINE_SIMILARITY: &'static str = "cosine_similarity"
pub const COSINE_DISTANCE: &'static str = "cosine_distance"
pub const DOT_PROD: &'static str = "dot_prod"
pub const EUCLIDEAN_DISTANCE: &'static str = "euclidean_distance"
pub const EUCLIDEAN_SQUARED_DISTANCE: &'static str = "euclidean_squared_distance"
pub const MANHATTAN: &'static str = "manhattan"
pub const HAMMING: &'static str = "hamming"
pub fn new(value: impl Into<String>) -> DistanceFunction
pub fn as_str(&self) -> &str
Sourcepub fn higher_is_closer(&self) -> Option<bool>
pub fn higher_is_closer(&self) -> Option<bool>
Whether a higher score means a closer match under this function.
Similarity functions rank descending; distance functions rank
ascending. Getting this backwards silently returns the worst matches
first, which is why it belongs here rather than in each provider.
Mirrors upstream’s DISTANCE_FUNCTION_DIRECTION_HELPER. None for a
function this port does not know the direction of — a caller must not
guess.
Trait Implementations§
Source§impl Clone for DistanceFunction
impl Clone for DistanceFunction
Source§fn clone(&self) -> DistanceFunction
fn clone(&self) -> DistanceFunction
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for DistanceFunction
impl Debug for DistanceFunction
Source§impl<'de> Deserialize<'de> for DistanceFunction
impl<'de> Deserialize<'de> for DistanceFunction
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<DistanceFunction, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<DistanceFunction, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl Eq for DistanceFunction
Source§impl Hash for DistanceFunction
impl Hash for DistanceFunction
Source§impl PartialEq for DistanceFunction
impl PartialEq for DistanceFunction
Source§impl Serialize for DistanceFunction
impl Serialize for DistanceFunction
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl StructuralPartialEq for DistanceFunction
Auto Trait Implementations§
impl Freeze for DistanceFunction
impl RefUnwindSafe for DistanceFunction
impl Send for DistanceFunction
impl Sync for DistanceFunction
impl Unpin for DistanceFunction
impl UnsafeUnpin for DistanceFunction
impl UnwindSafe for DistanceFunction
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more