Struct trees::linked::fully::forest::Forest[][src]

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

A nullable forest

Implementations

impl<T> Forest<T>[src]

pub fn new() -> Forest<T>[src]

Makes an empty Forest.

pub fn degree(&self) -> usize[src]

Returns the number of child nodes in Forest.

Examples

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

pub fn node_count(&self) -> usize[src]

Returns the number of all subnodes in Forest.

Examples

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

pub fn is_empty(&self) -> bool[src]

Returns true if the Forest is empty.

This operation should compute in O(1) time.

Examples

use trees::linked::fully::{tr,fr};
let mut forest = fr();
assert!( forest.is_empty() );
forest.push_back( tr(1) ); 
assert!( !forest.is_empty() );

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

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

pub fn first_mut(&mut self) -> Option<&mut Node<T>>[src]

Returns a mutable pointer to the first child of the forest, or None if it is empty.

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

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

pub fn last_mut(&mut self) -> Option<&mut Node<T>>[src]

Returns a mutable pointer to the last child of the forest, or None if it is empty.

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

Adds the tree as the first child.

Examples

use trees::linked::fully::{tr,fr};
let mut forest = fr();
forest.push_front( tr(1) );
assert_eq!( forest.to_string(), "( 1 )" );
forest.push_front( tr(2) );
assert_eq!( forest.to_string(), "( 2 1 )" );

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

Adds the tree as the first child.

Examples

use trees::linked::fully::{tr,fr};
let mut forest = fr();
forest.push_back( tr(1) );
assert_eq!( forest.to_string(), "( 1 )" );
forest.push_back( tr(2) );
assert_eq!( forest.to_string(), "( 1 2 )" );

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

remove and return the first child

Examples

use trees::linked::fully::tr;
let mut forest = -tr(1)-tr(2);
assert_eq!( forest.pop_front(), Some( tr(1) ));
assert_eq!( forest.to_string(), "( 2 )" );
assert_eq!( forest.pop_front(), Some( tr(2) ));
assert_eq!( forest.to_string(), "()" );

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

remove and return the first child

Examples

use trees::linked::fully::tr;
let mut forest = -tr(1)-tr(2);
assert_eq!( forest.pop_back(), Some( tr(2) ));
assert_eq!( forest.to_string(), "( 1 )" );
assert_eq!( forest.pop_back(), Some( tr(1) ));
assert_eq!( forest.to_string(), "()" );

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

merge the forest at front

Examples

use trees::linked::fully::{tr,fr};
let mut forest = fr();
forest.prepend( -tr(0)-tr(1) );
assert_eq!( forest.to_string(), "( 0 1 )" );
forest.prepend( -tr(2)-tr(3) );
assert_eq!( forest.to_string(), "( 2 3 0 1 )" );

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

merge the forest at back

Examples

use trees::linked::fully::{tr,fr};
let mut forest = fr();
forest.append( -tr(0)-tr(1) );
assert_eq!( forest.to_string(), "( 0 1 )" );
forest.append( -tr(2)-tr(3) );
assert_eq!( forest.to_string(), "( 0 1 2 3 )" );

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

Notable traits for Iter<'a, T>

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

Provides a forward iterator over child Nodes

Examples

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

let forest = fr::<i32>();
assert_eq!( forest.iter().next(), None );

let forest = -tr(1)-tr(2);
let mut iter = forest.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 children<'a>(&self) -> Iter<'a, T>

Notable traits for Iter<'a, T>

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

👎 Deprecated since 0.2.0:

please use iter instead

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

Notable traits for IterMut<'a, T>

impl<'a, T: 'a> Iterator for IterMut<'a, T> type Item = &'a mut Node<T>;
[src]

Provides a forward iterator over child Nodes with mutable references.

Examples

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

let mut forest = fr::<i32>();
assert_eq!( forest.iter_mut().next(), None );

let mut forest = -tr(1)-tr(2);
for child in forest.iter_mut() { child.data *= 10; }
assert_eq!( forest.to_string(), "( 10 20 )" );

pub fn children_mut<'a>(&mut self) -> IterMut<'a, T>

Notable traits for IterMut<'a, T>

impl<'a, T: 'a> Iterator for IterMut<'a, T> type Item = &'a mut Node<T>;
[src]

👎 Deprecated since 0.2.0:

please use iter_mut instead

pub fn onto_iter<'a>(&mut self) -> OntoIter<'a, T>

Notable traits for OntoIter<'a, T>

impl<'a, T: 'a> Iterator for OntoIter<'a, T> type Item = Subnode<'a, T>;
[src]

Provide an iterator over Forest’s Subnodes for insert/remove at any position. See Subnode’s document for more.

pub fn bfs<'a, 's: 'a>(&'s self) -> BfsForest<Splitted<Iter<'a, T>>>[src]

Provides a forward iterator in a breadth-first manner

Examples

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

let forest = fr::<i32>();
let visits = forest.bfs().iter.collect::<Vec<_>>();
assert!( visits.is_empty() );

let forest = -( tr(1)/tr(2)/tr(3) ) -( tr(4)/tr(5)/tr(6) );
let visits = forest.bfs().iter.collect::<Vec<_>>();
assert_eq!( visits, vec![
    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 }},
]);

pub fn bfs_mut<'a, 's: 'a>(&'s mut self) -> BfsForest<Splitted<IterMut<'a, T>>>[src]

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

Examples

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

let mut forest = fr::<i32>();
let visits = forest.bfs_mut().iter.collect::<Vec<_>>();
assert!( visits.is_empty() );

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

pub fn into_bfs(self) -> BfsForest<Splitted<IntoIter<T>>>[src]

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

Examples

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

let forest = fr::<i32>();
let visits = forest.into_bfs().iter.collect::<Vec<_>>();
assert!( visits.is_empty() );

let forest = -( tr(1)/tr(2)/tr(3) ) -( tr(4)/tr(5)/tr(6) );
let visits = forest.into_bfs().iter.collect::<Vec<_>>();
assert_eq!( visits, vec![
    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<T> Borrow<Forest<T>> for Tree<T>[src]

impl<T> BorrowMut<Forest<T>> for Tree<T>[src]

impl<T: Clone> Clone for Forest<T>[src]

impl<T: Debug> Debug for Forest<T>[src]

impl<T> Default for Forest<T>[src]

impl<T> Deref for Forest<T>[src]

type Target = Link

The resulting type after dereferencing.

impl<T> DerefMut for Forest<T>[src]

impl<T: Display> Display for Forest<T>[src]

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

type Output = Tree<T>

The resulting type after applying the / operator.

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

type Output = Tree<T>

The resulting type after applying the / operator.

impl<T> Div<Forest<T>> for Tree<T>[src]

type Output = Tree<T>

The resulting type after applying the / operator.

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

type Output = Tree<T>

The resulting type after applying the / operator.

impl<T> Drop for Forest<T>[src]

impl<T: Eq> Eq for Forest<T>[src]

impl<T> Extend<Tree<T>> for Forest<T>[src]

impl<T> From<Forest<T>> for ForestWalk<T>[src]

impl<T> FromIterator<Tree<T>> for Forest<T>[src]

impl<T: Hash> Hash for Forest<T>[src]

impl<T> Into<Forest<T>> for ForestWalk<T>[src]

impl<T> IntoIterator for Forest<T>[src]

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?

impl<T: Ord> Ord for Forest<T>[src]

impl<T: PartialEq> PartialEq<Forest<T>> for Forest<T>[src]

impl<T: PartialOrd> PartialOrd<Forest<T>> for Forest<T>[src]

impl<T: Send> Send for Forest<T>[src]

impl<'a, T: Clone> Sub<&'a Forest<T>> for Forest<T>[src]

type Output = Forest<T>

The resulting type after applying the - operator.

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

type Output = Forest<T>

The resulting type after applying the - operator.

impl<'a, 'b, T: Clone> Sub<&'b Forest<T>> for &'a Forest<T>[src]

type Output = Forest<T>

The resulting type after applying the - operator.

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

type Output = Forest<T>

The resulting type after applying the - operator.

impl<T> Sub<Forest<T>> for Forest<T>[src]

type Output = Forest<T>

The resulting type after applying the - operator.

impl<'a, T: Clone> Sub<Forest<T>> for &'a Forest<T>[src]

type Output = Forest<T>

The resulting type after applying the - operator.

impl<T> Sub<Tree<T>> for Forest<T>[src]

type Output = Forest<T>

The resulting type after applying the - operator.

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

type Output = Forest<T>

The resulting type after applying the - operator.

impl<T: Sync> Sync for Forest<T>[src]

Auto Trait Implementations

impl<T> RefUnwindSafe for Forest<T> where
    T: RefUnwindSafe

impl<T> Unpin for Forest<T>

impl<T> UnwindSafe for Forest<T> where
    T: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.