feat: add Mash distance metric and rolling entropy support
Implement the Mash distance metric across the CLI, index, and compact vector traits. This includes adding a `Mash` variant to the `DistanceMetric` enum and `MetricArg` CLI argument, implementing the conversion from Jaccard distances using the standard mutation-rate estimator formula, and updating documentation with supported metrics and algorithmic references. Additionally, add an `entropy` method to rolling statistics for computing order-specific entropy.
This commit is contained in:
1 parent
dc3392865f
commit
2610a4af79
7 files changed
+61
-8
No files matched your search
@@ -1,5 +1,16 @@
|
||||
use ndarray::{Array1, Array2};
|
||||
|
||||
/// Convert a Jaccard distance matrix (`1 - J`) into a Mash distance matrix, per
|
||||
/// https://mash.readthedocs.io/en/latest/distances.html:
|
||||
/// `D = -1/k * ln(2J / (1+J))`.
|
||||
fn jaccard_to_mash(d_jaccard: &Array2<f64>, k: usize) -> Array2<f64> {
|
||||
d_jaccard.mapv(|d| {
|
||||
let j = 1.0 - d;
|
||||
if j <= 0.0 { 1.0 }
|
||||
else { -1.0 / k as f64 * (2.0 * j / (1.0 + j)).ln() }
|
||||
})
|
||||
}
|
||||
|
||||
// ── Column-level weight statistic — total count or presence count per column.
|
||||
/// Additive across layers and partitions; used as denominator in normalised distances.
|
||||
///
|
||||
@@ -74,6 +85,12 @@ pub trait CountPartials: ColumnWeights {
|
||||
m
|
||||
}
|
||||
|
||||
/// Mash distance (https://mash.readthedocs.io/en/latest/distances.html), derived
|
||||
/// from the presence-threshold Jaccard distance.
|
||||
fn threshold_mash_dist_matrix(&self, k: usize, threshold: u32) -> Array2<f64> {
|
||||
jaccard_to_mash(&self.threshold_jaccard_dist_matrix(threshold), k)
|
||||
}
|
||||
|
||||
fn relfreq_bray_dist_matrix(&self) -> Array2<f64> {
|
||||
let global = self.col_weights();
|
||||
let mut m = self.partial_relfreq_bray(&global).mapv(|v| 1.0 - v);
|
||||
@@ -126,6 +143,12 @@ pub trait BitPartials: ColumnWeights {
|
||||
m
|
||||
}
|
||||
|
||||
/// Mash distance (https://mash.readthedocs.io/en/latest/distances.html), derived
|
||||
/// from the Jaccard distance.
|
||||
fn mash_dist_matrix(&self, k: usize) -> Array2<f64> {
|
||||
jaccard_to_mash(&self.jaccard_dist_matrix(), k)
|
||||
}
|
||||
|
||||
fn hamming_dist_matrix(&self) -> Array2<u64> {
|
||||
self.partial_hamming()
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user