Enum DistanceMetric

#[non_exhaustive]
pub enum DistanceMetric {
    Abstractness,
    Instability,
    DistanceFromMainSequence,
    CouplingFactor,
    NormalizedDistance,
}

One metric in the abstractness/instability component-distance family.

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.

Abstractness

Ratio of traits to all declared types.

Instability

Ratio of outgoing coupling to total coupling.

DistanceFromMainSequence

Absolute distance from abstractness + instability = 1.

CouplingFactor

Observed bidirectional coupling relative to its project maximum.

NormalizedDistance

Main-sequence distance discounted by component source size.

Implementations

impl DistanceMetric

pub const ALL: [Self; 5]

Every distance metric in stable display order.

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

Returns the stable public metric name.

pub const fn description(self) -> &'static str

Returns the metric’s concise semantic description.

pub fn calculate(self, input: &DistanceInput) -> f64

Calculates this formula over prepared component facts.

Trait Implementations

impl Clone for DistanceMetric

fn clone(&self) -> DistanceMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DistanceMetric

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

Formats the value using the given formatter.

impl Display for DistanceMetric

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

Formats the value using the given formatter.

impl Hash for DistanceMetric

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 DistanceMetric

fn cmp(&self, other: &DistanceMetric) -> 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,

Restrict a value to a certain interval.

impl PartialEq for DistanceMetric

fn eq(&self, other: &DistanceMetric) -> 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 PartialOrd for DistanceMetric

fn partial_cmp(&self, other: &DistanceMetric) -> 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 Copy for DistanceMetric

impl Eq for DistanceMetric

impl StructuralPartialEq for DistanceMetric