Struct Distance 

pub struct Distance(/* private fields */);

Pairwise distance in [0.0, 1.0]. Smaller = more similar.

Layer 1 (cluster, cluster_with_candidates) requires every distance value to land in this range; the type system enforces it. Built-in metric constructors on Config always return valid Distance values. For user-supplied distance closures, construct values via Distance::new (fail-fast on out-of-range) or Distance::clamped (saturate, NaN → Distance::MAX).

Implementations

impl Distance

pub const MIN: Self

Identity — two items are exactly the same.

pub const MAX: Self

Maximally dissimilar — “definitely not a match.”

pub fn new(value: f32) -> Option<Self>

Construct from a raw f32. Returns None if the value is NaN, infinite, or outside [0.0, 1.0].

pub fn clamped(value: f32) -> Self

Construct, clamping out-of-range values to the nearest endpoint. NaN becomes Distance::MAX — treating an unknowable distance as “definitely not a match” so it never merges two clusters.

pub fn value(self) -> f32

Underlying f32, for interop with raw-numerical APIs (e.g. building a kodama condensed matrix).

Trait Implementations

impl Clone for Distance

fn clone(&self) -> Distance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Distance

impl Debug for Distance

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

Formats the value using the given formatter.

impl PartialEq for Distance

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Distance

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Distance