Skip to main content

CompositeDistance

Struct CompositeDistance 

Source
pub struct CompositeDistance<A: DistanceMetric, B: DistanceMetric> { /* private fields */ }
Expand description

Weighted combination of two distance metrics.

Computes weight_a * A::distance(a, b) + weight_b * B::distance(a, b).

This lets callers express composite similarity notions such as “0.6 * string_similarity + 0.4 * embedding_distance” as a single metric that plugs into any clustering algorithm.

use clump::cluster::distance::{CompositeDistance, SquaredEuclidean, Euclidean, DistanceMetric};

let metric = CompositeDistance::new(SquaredEuclidean, Euclidean, 0.5, 0.5);
let d = metric.distance(&[0.0, 0.0], &[3.0, 4.0]);
// 0.5 * 25.0 + 0.5 * 5.0 = 15.0
assert!((d - 15.0).abs() < 1e-6);

Implementations§

Source§

impl<A: DistanceMetric, B: DistanceMetric> CompositeDistance<A, B>

Source

pub fn new(a: A, b: B, weight_a: f32, weight_b: f32) -> Self

Create a new composite distance from two metrics and their weights.

Weights are not required to sum to 1 – they are used as-is.

Trait Implementations§

Source§

impl<A: Clone + DistanceMetric, B: Clone + DistanceMetric> Clone for CompositeDistance<A, B>

Source§

fn clone(&self) -> CompositeDistance<A, B>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<A: Debug + DistanceMetric, B: Debug + DistanceMetric> Debug for CompositeDistance<A, B>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<A: DistanceMetric, B: DistanceMetric> DistanceMetric for CompositeDistance<A, B>

Source§

fn distance(&self, a: &[f32], b: &[f32]) -> f32

Compute the distance between two vectors of equal length.

Auto Trait Implementations§

§

impl<A, B> Freeze for CompositeDistance<A, B>
where A: Freeze, B: Freeze,

§

impl<A, B> RefUnwindSafe for CompositeDistance<A, B>

§

impl<A, B> Send for CompositeDistance<A, B>

§

impl<A, B> Sync for CompositeDistance<A, B>

§

impl<A, B> Unpin for CompositeDistance<A, B>
where A: Unpin, B: Unpin,

§

impl<A, B> UnsafeUnpin for CompositeDistance<A, B>
where A: UnsafeUnpin, B: UnsafeUnpin,

§

impl<A, B> UnwindSafe for CompositeDistance<A, B>
where A: UnwindSafe, B: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V