Skip to main content

TaxonomyTree

Struct TaxonomyTree 

Source
pub struct TaxonomyTree { /* private fields */ }
Expand description

A rooted taxonomy tree.

Nodes are stored in a flat vector; parent links encode the tree structure.

Implementations§

Source§

impl TaxonomyTree

Source

pub fn new() -> Self

Create a new empty taxonomy tree.

Source

pub fn add_node( &mut self, name: &str, rank: TaxonRank, parent: Option<usize>, ) -> usize

Add a node to the tree. Returns the node’s id.

The root node should have parent = None. All other nodes must reference a valid parent id.

Source

pub fn lca(&self, ids: &[usize]) -> Result<usize>

Compute the lowest common ancestor of a set of node ids.

Returns the deepest node that is an ancestor of all input nodes.

§Errors

Returns an error if ids is empty or any id is out of range.

Source

pub fn lineage(&self, id: usize) -> Vec<usize>

Get the full lineage (path to root) for a node, ordered from the node to root.

Source

pub fn depth(&self, id: usize) -> usize

Depth of a node (root = 0).

Trait Implementations§

Source§

impl Clone for TaxonomyTree

Source§

fn clone(&self) -> TaxonomyTree

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TaxonomyTree

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TaxonomyTree

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.