Struct trees::linked::fully::onto_iter::Subnode

pub struct Subnode<'a, T: 'a> { /* fields omitted */ }

Wrapper of Node for allowing modification of parent or sib links. Any Node that is the root of some Tree is impossible to be Subnode.

Methods

impl<'a, T: 'a> Subnode<'a, T>

pub fn insert_before(&mut self, sib: Tree<T>)

Insert sib tree before self. The newly inserted node will not be iterated over by the currently running iterator.

Examples

use trees::linked::fully::tr;
let mut tree = tr(0) /tr(1)/tr(2);
for mut sub in tree.root_mut().onto_iter() { sub.insert_before( tr(3) ); }
assert_eq!( tree.to_string(), "0( 3 1 3 2 )" );

pub fn insert_after(&mut self, sib: Tree<T>)

Insert sib tree after self. The newly inserted node will not be iterated over by the currently running iterator.

Examples

use trees::linked::fully::tr;
let mut tree = tr(0) /tr(1)/tr(2);
for mut sub in tree.root_mut().onto_iter() { sub.insert_after( tr(3) ); }
assert_eq!( tree.to_string(), "0( 1 3 2 3 )" );

pub fn depart(self) -> Tree<T>

The subtree departs from its parent and becomes an indepent Tree.

Examples

use trees::linked::fully::{tr,fr};

let mut forest = -tr(1)-tr(2)-tr(3);
//for sub in forest.onto_iter() { sub.depart(); }
//forest.onto_iter().next().unwrap().depart();
//assert_eq!( forest, fr() );

Methods from Deref<Target = Node<T>>

pub fn is_leaf(&self) -> bool

pub fn degree(&self) -> usize

Returns the number of subtrees in Forest.

Examples

use trees::linked::fully::tr;
let tree = tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) );
assert_eq!( tree.degree(), 2 );

pub fn node_count(&self) -> usize

Returns the number of all subnodes in Forest.

Examples

use trees::linked::fully::tr;
let tree = tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) );
assert_eq!( tree.node_count(), 7 );

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

Returns the first child of the forest, or None if it is empty.

pub fn forest(&self) -> &Forest<T>

Returns the given Tree's children as a borrowed Forest.

Examples

use trees::linked::fully::tr;
let mut tree = tr(0) /tr(1)/tr(2);
assert_eq!( tree.forest().to_string(), "( 1 2 )" );

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

Returns the last child of the forest, or None if it is empty.

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

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

Examples

use trees::linked::fully::tr;
let mut tree = tr(0) /(tr(1)-tr(2)-tr(3));
tree.iter().for_each( |child| assert_eq!( child.parent(), Some( tree.root() )));

Important traits for Iter<'a, T>

impl<'a, T: 'a> Iterator for Iter<'a, T> type Item = &'a Node<T>;

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

Provides a forward iterator over child Nodes

Examples

use trees::linked::fully::tr;

let tree = tr(0);
assert_eq!( tree.iter().next(), None );

let tree = tr(0) /tr(1)/tr(2);
let mut iter = tree.iter();
assert_eq!( iter.next(), Some( tr(1).root() ));
assert_eq!( iter.next(), Some( tr(2).root() ));
assert_eq!( iter.next(), None );
assert_eq!( iter.next(), None );

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

Provides a forward iterator in a breadth-first manner

Examples

use trees::{bfs,Size};
use trees::linked::fully::tr;

let tree = tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) );
let visits = tree.root().bfs().iter.collect::<Vec<_>>();
assert_eq!( visits, vec![
    bfs::Visit{ data: &0, size: Size{ degree: 2, node_cnt: 7 }},
    bfs::Visit{ data: &1, size: Size{ degree: 2, node_cnt: 3 }},
    bfs::Visit{ data: &4, size: Size{ degree: 2, node_cnt: 3 }},
    bfs::Visit{ data: &2, size: Size{ degree: 0, node_cnt: 1 }},
    bfs::Visit{ data: &3, size: Size{ degree: 0, node_cnt: 1 }},
    bfs::Visit{ data: &5, size: Size{ degree: 0, node_cnt: 1 }},
    bfs::Visit{ data: &6, size: Size{ degree: 0, node_cnt: 1 }},
]);

Trait Implementations

impl<'a, T: 'a> Deref for Subnode<'a, T>

type Target = Node<T>

The resulting type after dereferencing.

fn deref(&self) -> &Node<T>

Dereferences the value.