Struct trees::tree::Tree

pub struct Tree<T> { /* fields omitted */ }

Composed of a root Node and a list of its child Nodes.

Implementations

impl<T> Tree<T>

pub fn new(data: T) -> Tree<T>

Creates a Tree containing only root node associated with given data.

pub fn from_tuple<Tuple, Shape>(tuple: Tuple) -> Self where
    Tuple: TupleTree<T, Shape>, 

Constructs tree from tuple notations.

Examples

use trees::{Tree, tr};

let tree = Tree::<i32>::from_tuple(( 0, (1,2), (3,4) ));
assert_eq!( tree, tr(0) /(tr(1)/tr(2)) /(tr(3)/tr(4)) );
assert_eq!( tree.to_string(), "0( 1( 2 ) 3( 4 ) )" );

pub fn root(&self) -> &Node<T>

Reference of the root node.

pub fn root_mut(&mut self) -> Pin<&mut Node<T>>

Mutable reference of the root node.

pub fn iter_mut<'a, 's: 'a>(&'s mut self) -> IterMut<'a, T>

Provides a forward iterator over child Nodes with mutable references.

Examples

use trees::Tree;

let mut tree = Tree::<i32>::from_tuple(( 0, 1, 2, 3 ));
tree.iter_mut().for_each( |mut child| *child.data_mut() *= 10 );
assert_eq!( tree.to_string(), "0( 10 20 30 )" );

pub fn push_front(&mut self, tree: Tree<T>)

Adds the tree as the first child.

Examples

use trees::Tree;
let mut tree = Tree::new(0);
tree.push_front( Tree::new(1) );
assert_eq!( tree.to_string(), "0( 1 )" );
tree.push_front( Tree::new(2) );
assert_eq!( tree.to_string(), "0( 2 1 )" );

pub fn push_back(&mut self, tree: Tree<T>)

Adds the tree as the last child.

Examples

use trees::Tree;
let mut tree = Tree::new(0);
tree.push_back( Tree::new(1) );
assert_eq!( tree.to_string(), "0( 1 )" );
tree.push_back( Tree::new(2) );
assert_eq!( tree.to_string(), "0( 1 2 )" );

pub fn prepend(&mut self, forest: Forest<T>)

Adds all the forest's trees at front of children list.

Examples

use trees::{Forest, Tree};

let mut tree = Tree::new(0);
tree.push_back( Tree::new(1) );
tree.push_back( Tree::new(2) );
let mut forest = Forest::new();
forest.push_back( Tree::new(3) );
forest.push_back( Tree::new(4) );
tree.prepend( forest );
assert_eq!( tree.to_string(), "0( 3 4 1 2 )" );

pub fn append(&mut self, forest: Forest<T>)

Adds all the forest's trees at back of children list.

Examples

use trees::{Forest, Tree};

let mut tree = Tree::new(0);
tree.push_back( Tree::new(1) );
tree.push_back( Tree::new(2) );
let mut forest = Forest::new();
forest.push_back( Tree::new(3) );
forest.push_back( Tree::new(4) );
tree.root_mut().append( forest );
assert_eq!( tree.to_string(), "0( 1 2 3 4 )" );

pub fn abandon(&mut self) -> Forest<T>

Removes and returns the given Tree's children.

Examples

use trees::{Forest, Tree};

let mut tree = Tree::new(0);
tree.push_back( Tree::new(1) );
tree.push_back( Tree::new(2) );
let forest = tree.abandon();
assert_eq!( forest.to_string(), "( 1 2 )" );
assert_eq!( tree, Tree::new(0) );

pub fn pop_front(&mut self) -> Option<Tree<T>>

Removes and returns the first child.

Examples

use trees::Tree;

let mut tree = Tree::new(0);
tree.push_back( Tree::new(1) );
tree.push_back( Tree::new(2) );
assert_eq!( tree.to_string(), "0( 1 2 )" );
assert_eq!( tree.pop_front(), Some( Tree::new(1) ));
assert_eq!( tree.to_string(), "0( 2 )" );
assert_eq!( tree.pop_front(), Some( Tree::new(2) ));
assert_eq!( tree.to_string(), "0" );
assert_eq!( tree.pop_front(), None );

pub fn pop_back(&mut self) -> Option<Tree<T>>

Removes and returns the last child.

Examples

use trees::Tree;

let mut tree = Tree::new(0);
tree.push_back( Tree::new(1) );
tree.push_back( Tree::new(2) );
assert_eq!( tree.to_string(), "0( 1 2 )" );
assert_eq!( tree.pop_back(), Some( Tree::new(2) ));
assert_eq!( tree.to_string(), "0( 1 )" );
assert_eq!( tree.pop_back(), Some( Tree::new(1) ));
assert_eq!( tree.to_string(), "0" );
assert_eq!( tree.pop_back(), None );

pub fn front_mut(&mut self) -> Option<Pin<&mut Node<T>>>

Returns a mutable reference to the first child of this node, or None if it has no child.

pub fn back_mut(&mut self) -> Option<Pin<&mut Node<T>>>

Returns a mutable reference to the last child of this node, or None if it has no child.

impl<T> Tree<T>

pub fn bfs_children_mut(&mut self) -> BfsForest<Splitted<IterMut<'_, T>>>

Provides a forward iterator with mutable references in a breadth-first manner, which iterates over all its descendants.

Examples

use trees::{tr, Tree};

let mut tree = Tree::from_tuple(( 0, (1,2,3), (4,5,6), ));
tree.bfs_children_mut().iter
    .zip( 1.. )
    .for_each( |(visit,nth)| *visit.data += 10 * nth );
assert_eq!( tree, Tree::<i32>::from_tuple(( 0, (11,32,43), (24,55,66), )));

pub fn bfs_mut(&mut self) -> BfsTree<Splitted<IterMut<'_, T>>>

Provides a forward iterator with mutable references in a breadth-first manner.

Examples

use trees::{tr, Tree};

let mut tree = Tree::from_tuple(( 0, (1,2,3), (4,5,6), ));
tree.bfs_mut().iter
    .zip( 1.. )
    .for_each( |(visit,nth)| *visit.data += 10 * nth );
assert_eq!( tree, Tree::<i32>::from_tuple(( 10, (21,42,53), (34,65,76), )));

pub fn into_bfs(self) -> BfsTree<Splitted<IntoIter<T>>>

Provides a forward iterator with owned data in a breadth-first manner.

Examples

use trees::{bfs,Size};
use trees::Tree;

let tree = Tree::<i32>::from_tuple(( 0, (1,2,3), (4,5,6) ));
let visits = tree.into_bfs().iter.collect::<Vec<_>>();
assert_eq!( visits, vec![
    bfs::Visit{ data: 0, size: Size{ degree: 2, descendants: 6 }},
    bfs::Visit{ data: 1, size: Size{ degree: 2, descendants: 2 }},
    bfs::Visit{ data: 4, size: Size{ degree: 2, descendants: 2 }},
    bfs::Visit{ data: 2, size: Size{ degree: 0, descendants: 0 }},
    bfs::Visit{ data: 3, size: Size{ degree: 0, descendants: 0 }},
    bfs::Visit{ data: 5, size: Size{ degree: 0, descendants: 0 }},
    bfs::Visit{ data: 6, size: Size{ degree: 0, descendants: 0 }},
]);

Methods from Deref<Target = Node<T>>

pub fn data(&self) -> &T

Reference of its associated data.

pub fn has_no_child(&self) -> bool

Returns true if Node has no child nodes.

Examples

use trees::Tree;
let mut tree = Tree::new(0);
let mut root = tree.root_mut();
assert!( root.has_no_child() );
root.push_back( Tree::new(1) );
assert!( !root.has_no_child() );

pub fn degree(&self) -> usize

Returns the number of child nodes in Node.

Examples

use trees::Tree;
let mut tree = Tree::new(0);
let mut root = tree.root_mut();
assert_eq!( root.degree(), 0 );
root.push_back( Tree::new(1) );
assert_eq!( root.degree(), 1 );
root.push_back( Tree::new(2) );
assert_eq!( root.degree(), 2 );

pub fn node_count(&self) -> usize

Returns the number of all child nodes in Node, including itself.

Examples

use trees::Tree;

let tree = Tree::<i32>::from_tuple(( 0, (1,2), (3,4) ));
assert_eq!( tree.root().node_count(), 5 );

pub fn parent(&self) -> Option<&Node<T>>

Returns the parent node of this node, or None if it is the root node.

Examples

use trees::Tree;

let tree = Tree::<i32>::from_tuple(( 0, 1, 2, 3 ));
tree.root().iter().for_each( |child| {
    assert_eq!( child.parent(), Some( tree.root()))
});

pub fn iter<'a, 's: 'a>(&'s self) -> Iter<'a, T>

Provides a forward iterator over child Nodes

Examples

use trees::Tree;

let mut tree = Tree::new(0);
assert_eq!( tree.iter().next(), None );

tree.push_back( Tree::new(1) );
tree.push_back( Tree::new(2) );
let mut iter = tree.root().iter();
assert_eq!( iter.next(), Some( Tree::new(1).root() ));
assert_eq!( iter.next(), Some( Tree::new(2).root() ));
assert_eq!( iter.next(), None );

pub fn front(&self) -> Option<&Node<T>>

Returns the first child of this node, or None if it has no child.

pub fn back(&self) -> Option<&Node<T>>

Returns the last child of this node, or None if it has no child.

pub fn deep_clone(&self) -> Tree<T> where
    T: Clone, 

Clones the node deeply and creates a new tree.

Examples

use trees::Tree;

let tree = Tree::<i32>::from_tuple(( 0, (1,2,3), (4,5,6), (7,8,9), ));
assert_eq!( tree.iter().nth(1).unwrap().deep_clone(),
    Tree::from_tuple(( 4,5,6 )));

pub fn deep_clone_forest(&self) -> Forest<T> where
    T: Clone, 

Clones the node's descendant nodes as a forest.

Examples

use trees::{Tree,Forest};

let tree = Tree::<i32>::from_tuple(( 0, (1,2,3), (4,5,6), (7,8,9), ));
assert_eq!( tree.iter().nth(1).unwrap().deep_clone_forest(),
    Forest::from_tuple(( 5,6 )));

pub fn bfs_children(&self) -> BfsForest<Splitted<Iter<'_, T>>>

Provides a forward iterator in a breadth-first manner, which iterates over all its descendants.

Examples

use trees::Tree;

let tree = Tree::from_tuple(( 0, (1,2,3), (4,5,6), ));
let visits = tree.root().bfs_children().iter
    .map( |visit| (*visit.data, visit.size.degree, visit.size.descendants ))
    .collect::<Vec<_>>();
assert_eq!( visits, vec![ (1, 2, 2), (4, 2, 2), (2, 0, 0), (3, 0, 0), (5, 0, 0), (6, 0, 0), ]);

pub fn bfs(&self) -> BfsTree<Splitted<Iter<'_, T>>>

Provides a forward iterator in a breadth-first manner.

Examples

use trees::Tree;

let tree = Tree::from_tuple(( 0, (1,2,3), (4,5,6), ));
let visits = tree.root().bfs().iter
    .map( |visit| (*visit.data, visit.size.degree, visit.size.descendants ))
    .collect::<Vec<_>>();
assert_eq!( visits, vec![ (0, 2, 6), (1, 2, 2), (4, 2, 2), (2, 0, 0), (3, 0, 0), (5, 0, 0), (6, 0, 0), ]);

Trait Implementations

impl<T: Clone> Clone for Tree<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Tree<T>

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

Formats the value using the given formatter.

impl<T> Deref for Tree<T>

type Target = Node<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Display> Display for Tree<T>

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

Formats the value using the given formatter.

impl<'a, T: Clone> Div<&'a Forest<T>> for Tree<T>

type Output = Tree<T>

The resulting type after applying the / operator.

fn div(mut self: Self, rhs: &'a Forest<T>) -> Tree<T>

Performs the / operation.

impl<'a, T: Clone> Div<&'a Forest<T>> for &'a Tree<T>

type Output = Tree<T>

The resulting type after applying the / operator.

fn div(self, rhs: &'a Forest<T>) -> Tree<T>

Performs the / operation.

impl<'a, T: Clone> Div<&'a Tree<T>> for Tree<T>

type Output = Tree<T>

The resulting type after applying the / operator.

fn div(mut self: Self, rhs: &'a Tree<T>) -> Tree<T>

Performs the / operation.

impl<'a, T: Clone> Div<&'a Tree<T>> for &'a Tree<T>

type Output = Tree<T>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Tree<T>

Performs the / operation.

impl<T> Div<()> for Tree<T>

type Output = Tree<T>

The resulting type after applying the / operator.

fn div(self, _rhs: ()) -> Tree<T>

Performs the / operation.

impl<'a, T: Clone> Div<()> for &'a Tree<T>

type Output = Tree<T>

The resulting type after applying the / operator.

fn div(self, _rhs: ()) -> Tree<T>

Performs the / operation.

impl<T> Div<Forest<T>> for Tree<T>

type Output = Tree<T>

The resulting type after applying the / operator.

fn div(mut self: Self, rhs: Forest<T>) -> Tree<T>

Performs the / operation.

impl<'a, T: Clone> Div<Forest<T>> for &'a Tree<T>

type Output = Tree<T>

The resulting type after applying the / operator.

fn div(self, rhs: Forest<T>) -> Tree<T>

Performs the / operation.

impl<T> Div<Tree<T>> for Tree<T>

type Output = Tree<T>

The resulting type after applying the / operator.

fn div(mut self: Self, rhs: Tree<T>) -> Tree<T>

Performs the / operation.

impl<'a, T: Clone> Div<Tree<T>> for &'a Tree<T>

type Output = Tree<T>

The resulting type after applying the / operator.

fn div(self, rhs: Tree<T>) -> Tree<T>

Performs the / operation.

impl<T> Drop for Tree<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Eq> Eq for Tree<T>

impl<T> Extend<Tree<T>> for RcNode<T>

fn extend<I: IntoIterator<Item = Tree<T>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T, Iter> From<BfsTree<Iter>> for Tree<T> where
    Iter: Iterator<Item = Visit<T>>, 

fn from(tree_iter: BfsTree<Iter>) -> Self

Performs the conversion.

impl<T> From<Tree<T>> for TreeWalk<T>

fn from(tree: Tree<T>) -> Self

Performs the conversion.

impl<T> From<Tree<T>> for RcNode<T>

fn from(tree: Tree<T>) -> Self

Performs the conversion.

impl<T> From<TreeWalk<T>> for Tree<T>

fn from(walk: TreeWalk<T>) -> Self

Performs the conversion.

impl<T: Hash> Hash for Tree<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T> IntoIterator for Tree<T>

type Item = Tree<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

impl<T> Neg for Tree<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn neg(self) -> Forest<T>

Performs the unary - operation.

impl<'a, T: Clone> Neg for &'a Tree<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn neg(self) -> Forest<T>

Performs the unary - operation.

impl<T: Ord> Ord for Tree<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Tree<T>> for Tree<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Self) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Tree<T>> for Tree<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Split for Tree<T>

type Item = T

type Iter = IntoIter<T>

fn split(mut self: Self) -> (T, IntoIter<T>, usize)

impl<'a, T: Clone> Sub<&'a Tree<T>> for Tree<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Tree<T>) -> Forest<T>

Performs the - operation.

impl<'a, T: Clone> Sub<&'a Tree<T>> for &'a Tree<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Forest<T>

Performs the - operation.

impl<'a, T: Clone> Sub<&'a Tree<T>> for Forest<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn sub(mut self: Self, rhs: &'a Tree<T>) -> Self

Performs the - operation.

impl<'a, 'b, T: Clone> Sub<&'b Tree<T>> for &'a Forest<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Tree<T>) -> Forest<T>

Performs the - operation.

impl<T> Sub<Tree<T>> for Tree<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Forest<T>

Performs the - operation.

impl<'a, T: Clone> Sub<Tree<T>> for &'a Tree<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Tree<T>) -> Forest<T>

Performs the - operation.

impl<T> Sub<Tree<T>> for Forest<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn sub(mut self: Self, rhs: Tree<T>) -> Self

Performs the - operation.

impl<'a, T: Clone> Sub<Tree<T>> for &'a Forest<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Tree<T>) -> Forest<T>

Performs the - operation.