Struct umgap::tree::Tree

pub struct Tree<T: Default + Copy> {
    pub root: TaxonId,
    pub value: T,
    pub children: Vec<Tree<T>>,
}

A recursive tree of TaxonId’s and a label.

Fields

root: TaxonId

The root of the (sub)tree.

value: T

The label of this node.

children: Vec<Tree<T>>

The children of this node.

Implementations

impl<T: Default + Copy> Tree<T>

pub fn new( root: TaxonId, parents: &[Option<TaxonId>], taxons: &HashMap<TaxonId, T> ) -> Result<Self>

Create a new Tree.

root will be the root taxon of the tree. In parents, on index i should be the parent of taxon with id i, if any. taxons links taxa to their labels. Only taxon ids included in taxons and their ancestors will be in the tree.

pub fn collapse<F>(&self, combine: &F) -> Self

where F: Fn(T, T) -> T,

Collapses the label of a parent with a single child into that child using the combine function, as long as there are parents with single children.

pub fn aggregate<F>(&self, combine: &F) -> Self

where F: Fn(T, T) -> T,

Replaces every label in the tree with the aggregate label of all their descendants, with given combine function. The aggregation of children happens in pre-order.