Struct light_phylogeny::ArenaTree

pub struct ArenaTree<T> where
    T: PartialEq,  {
    pub arena: Vec<Noeud<T>>,
}

ArenaTree Structure. It describes a binary phylogenetic tree.

Inspirated from https://dev.to/deciduously/no-more-tears-no-more-knots-arena-allocated-trees-in-rust-44k6

Ben Lovy https://deciduously.com/

Fields

arena: Vec<Noeud<T>>

Implementations

impl<T> ArenaTree<T> where
    T: PartialEq + Default + Debug, 

pub fn node(&mut self, val: T) -> usize

Add a node with a given val and send its new index. If the node already exists, send its index.

pub fn new_node(&mut self, val: T) -> usize

Add a node with a given val and send its new index. If the node already exists, send a panic alert.

pub fn get_node(&mut self, val: T) -> usize

Get the index of a node from its val. If the node does not exists, send a panic alert.

pub fn get_index(&mut self, name: String) -> Result<usize, usize>

Get the index of a node from its name. Send a Result(index, error)

pub fn get_root(&mut self) -> usize

Get the index of the root.

pub fn is_leaf(&self, idx: usize) -> bool

Check if the node is a leaf.

pub fn is_left(&self, idx: usize) -> bool

Check if the node is a left node.

pub fn is_root(&self, idx: usize) -> bool

Check if the node is the root.

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

Get the depth of the node in the tree.

pub fn get_largest_x(&mut self) -> f32

Get the largest x value of a tree.

pub fn get_largest_y(&mut self) -> f32

Get the largest y value of a tree.

pub fn get_largest_y_nofl(&mut self) -> f32

Get the largest y value of a tree execpt the free living part.

pub fn get_smallest_x(&mut self) -> f32

Get the smallest x value of a tree.

pub fn get_smallest_y(&mut self) -> f32

Get the smallest y value of a tree.

pub fn get_smallest_l(&mut self) -> f32

Get the smallest l value of a tree.

pub fn get_largest_height(&mut self) -> f32

Get the largest height .

pub fn copie(&mut self) -> ArenaTree<String>

Copy a whole ArenaTree structure.

Trait Implementations

impl<T: Debug> Debug for ArenaTree<T> where
    T: PartialEq, 

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

Formats the value using the given formatter.

impl<T: Default> Default for ArenaTree<T> where
    T: PartialEq, 

fn default() -> ArenaTree<T>

Returns the “default value” for a type.