Struct trees::linked::fully::forest::Forest

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

A nullable forest

Methods

impl<T> Forest<T>

pub fn new() -> Forest<T>

Makes an empty Forest.

pub fn degree(&self) -> usize

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

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

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>>

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

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

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

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

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

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

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>)

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>)

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>>

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>>

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>)

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>)

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 )" );

Important traits for Iter<'a, T>

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

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

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 );

Important traits for IterMut<'a, T>

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

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

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 mut child in forest.iter_mut() { child.data *= 10; }
assert_eq!( forest.to_string(), "( 10 20 )" );

Important traits for OntoIter<'a, T>

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

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

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>>>

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>>>

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>>>

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>

fn borrow(&self) -> &Forest<T>

Immutably borrows from an owned value.

impl<T: Clone> Clone for Forest<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Forest<T>

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

Formats the value using the given formatter.

impl<T> Default for Forest<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T> Deref for Forest<T>

type Target = Link

The resulting type after dereferencing.

fn deref(&self) -> &Link

Dereferences the value.

impl<T: Display> Display for Forest<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(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<T> Div<Forest<T>> for 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<'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> Drop for Forest<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Eq> Eq for Forest<T>

impl<T> Extend<Tree<T>> for Forest<T>

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

Extends a collection with the contents of an iterator.

impl<T> From<Forest<T>> for ForestWalk<T>

fn from(forest: Forest<T>) -> Self

Performs the conversion.

impl<T> FromIterator<Tree<T>> for Forest<T>

fn from_iter<I: IntoIterator<Item = Tree<T>>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Hash> Hash for Forest<T>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T> Into<Forest<T>> for ForestWalk<T>

fn into(self) -> Forest<T>

Performs the conversion.

impl<T> IntoIterator for Forest<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?

Important traits for IntoIter<T>

impl<T> Iterator for IntoIter<T> type Item = Tree<T>;

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

impl<T: Ord> Ord for Forest<T>

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Forest<T>> for Forest<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<Forest<T>> for Forest<T>

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

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

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

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

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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: Send> Send for Forest<T>

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

type Output = Forest<T>

The resulting type after applying the - operator.

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

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(self, rhs: &'a Tree<T>) -> Self

Performs the - operation.

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

type Output = Forest<T>

The resulting type after applying the - operator.

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

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<Forest<T>> for Forest<T>

type Output = Forest<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

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

type Output = Forest<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Forest<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(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.

impl<T: Sync> Sync for Forest<T>