Struct umgap::taxon::TaxonTree

pub struct TaxonTree {
    pub root: TaxonId,
    pub children: HashMap<TaxonId, Vec<TaxonId>>,
    /* private fields */
}

Represents a taxonomy tree. Each node is a Taxon represented by its TaxonId.

Fields

root: TaxonId

The root taxon

children: HashMap<TaxonId, Vec<TaxonId>>

A map that maps each taxon to its children

Implementations

impl TaxonTree

pub fn new(taxons: &[Taxon]) -> TaxonTree

Creates a taxon tree from the given taxons.

pub fn filter_ancestors<F>(&self, filter: F) -> Vec<Option<TaxonId>>

where F: Fn(TaxonId) -> bool,

Returns a filtered list of taxons (or more specifically, their identifiers)

pub fn child_count(&self, whose: TaxonId) -> usize

Returns the amount of children a given taxon has in this tree.

pub fn snapping( &self, taxons: &TaxonList, ranked_only: bool ) -> Vec<Option<TaxonId>>

Converts a list of taxons into their respective taxon id’s for this tree. Replaces each invalid (or unranked) taxon with it’s first valid (and ranked) ancestor.

Arguments:

• taxons: a vector of taxons, indexed by their TaxonId.
• ranked_only: whether to include only taxons with a rank.

Trait Implementations

impl IntoIterator for TaxonTree

type IntoIter = EulerIterator

Which kind of iterator are we turning this into?

type Item = (usize, usize)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.