refactor: restructure obikphylo module layout and adjust visibility

Relocate cardcomp into the siblings directory and update internal import paths to reflect the new hierarchy. Adjust the crate's public API surface by updating module declarations and re-exports. This is a purely structural change with no modifications to logic, data models, or runtime behavior.
This commit is contained in:
Eric Coissac
2026-08-28 19:46:09 +02:00
parent 4ea3cd32ba
commit 6bdc9354d3
3 changed files with 12 additions and 6 deletions
+9 -5
View File
@@ -5,13 +5,17 @@
//! //!
//! Starts with [`siblings`] (family presence-mask annex, SNP distance, //! Starts with [`siblings`] (family presence-mask annex, SNP distance,
//! cardinality, pseudo-alignment); further phylo-domain functionality //! cardinality, pseudo-alignment); further phylo-domain functionality
//! (currently `obikindex::distance`/`obikindex::cardcomp`) moves here //! (currently [`distance`]) moves here incrementally.
//! incrementally. //!
//! `siblings` is temporarily disconnected (commented out below) while
//! `obikindex`'s stateless audit is being caught up with piece by piece —
//! see the project memory on this. `cardcomp` already moved into
//! `siblings/` (it's sibling-specific) and is unaffected by the
//! disconnection itself compiling; it just isn't reachable from outside
//! this crate until `siblings` comes back.
mod cardcomp;
mod distance; mod distance;
mod matrix_store; mod matrix_store;
pub mod siblings; // pub mod siblings; // temporarily disconnected — see module doc above.
pub use cardcomp::{cardinality_transition_probs, composition_transition_probs, pairwise_cost_matrix};
pub use distance::{DistanceMetric, DistanceOutput}; pub use distance::{DistanceMetric, DistanceOutput};
@@ -17,7 +17,7 @@
//! since TNT/PhyG search *unrooted* trees) if the cost matrix is //! since TNT/PhyG search *unrooted* trees) if the cost matrix is
//! symmetric, the discrete-parsimony analogue of CTMC reversibility. //! symmetric, the discrete-parsimony analogue of CTMC reversibility.
use crate::siblings::{BasePairTally, CardinalityTally}; use super::{BasePairTally, CardinalityTally};
/// Row-stochastic 5×5 cardinality transition probabilities (`0..=4`), /// Row-stochastic 5×5 cardinality transition probabilities (`0..=4`),
/// diagonal included ("stay at the same cardinality"), from /// diagonal included ("stay at the same cardinality"), from
+2
View File
@@ -45,6 +45,7 @@
mod alignment; mod alignment;
mod build; mod build;
mod cache; mod cache;
mod cardcomp;
mod cardinality; mod cardinality;
mod distance; mod distance;
mod entropy; mod entropy;
@@ -62,6 +63,7 @@ mod tests;
pub use alignment::{SnpAlignment, SnpAlignmentExt}; pub use alignment::{SnpAlignment, SnpAlignmentExt};
pub use build::SiblingAnnexBuildExt; pub use build::SiblingAnnexBuildExt;
pub use cardcomp::{cardinality_transition_probs, composition_transition_probs, pairwise_cost_matrix};
pub use cardinality::{CardinalityExt, CardinalityTally}; pub use cardinality::{CardinalityExt, CardinalityTally};
pub use distance::{BasePairTally, DistanceExt, RawSnpDistanceOutput}; pub use distance::{BasePairTally, DistanceExt, RawSnpDistanceOutput};
pub use entropy::ShannonEntropyExt; pub use entropy::ShannonEntropyExt;