Struct trees::linked::fully::node::Node

#[repr(C)]
pub struct Node<T> {
    pub data: T,
    // some fields omitted
}

Fields

data: T

Methods

impl<T> 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 forest_mut(&mut self) -> Pin<&mut Forest<T>>

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

Examples

use trees::linked::fully::tr;
let mut tree = tr(0) /tr(1)/tr(2);
for mut child in tree.root_mut().forest_mut().iter_mut() { child.data *= 10; }
assert_eq!( tree.to_string(), "0( 10 20 )" );

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

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

Adds the tree as the first child.

Examples

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

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

Add the tree as the last child

Examples

use trees::linked::fully::tr;
let mut tree = tr(0);
tree.root_mut().push_back( tr(1) );
assert_eq!( tree.to_string(), "0( 1 )" );
tree.root_mut().push_back( tr(2) );
assert_eq!( tree.to_string(), "0( 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 tree = tr(0) /tr(1)/tr(2);
assert_eq!( tree.root_mut().pop_front(), Some( tr(1) ));
assert_eq!( tree.to_string(), "0( 2 )" );
assert_eq!( tree.root_mut().pop_front(), Some( tr(2) ));
assert_eq!( tree.to_string(), "0" );

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

Remove and return the last child

Examples

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

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

Add all the forest's trees at front of children list

Examples

use trees::linked::fully::tr;
let mut tree = tr(0);
tree.root_mut().prepend( -tr(1)-tr(2) );
assert_eq!( tree.to_string(), "0( 1 2 )" );
tree.root_mut().prepend( -tr(3)-tr(4) );
assert_eq!( tree.to_string(), "0( 3 4 1 2 )" );

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

Add all the forest's trees at back of children list

Examples

use trees::linked::fully::tr;
let mut tree = tr(0);
tree.root_mut().append( -tr(1)-tr(2) );
assert_eq!( tree.to_string(), "0( 1 2 )" );
tree.root_mut().append( -tr(3)-tr(4) );
assert_eq!( tree.to_string(), "0( 1 2 3 4 )" );

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

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, 's: 'a>(&'s mut self) -> IterMut<'a, T>

Provides a forward iterator over child Nodes with mutable references.

Examples

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

let mut tree = tr(0);
assert_eq!( tree.root_mut().iter_mut().next(), None );

let mut tree = tr(0) /tr(1)/tr(2);
for mut child in tree.root_mut().iter_mut() { child.data *= 10; }
assert_eq!( tree.to_string(), "0( 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, 's: 'a>(&'s mut self) -> OntoIter<'a, T>

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

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 }},
]);

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::{bfs,Size};
use trees::linked::fully::tr;

let mut tree = tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) );
let mut root = tree.root_mut();
root.bfs_mut().iter.zip( 0.. ).for_each( |(visit,nth)| (*visit.data) += 10 * nth );
assert_eq!( tree, tr(0) /( tr(11)/tr(32)/tr(43) ) /( tr(24)/tr(55)/tr(66) ));

Trait Implementations

impl<T> Borrow<Node<T>> for Tree<T>

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

Immutably borrows from an owned value.

impl<T: Debug> Debug for Node<T>

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

Formats the value using the given formatter.

impl<T> Deref for Node<T>

type Target = Link

The resulting type after dereferencing.

fn deref(&self) -> &Link

Dereferences the value.

impl<T: Display> Display for Node<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Node<T>

impl<T> Extend<Tree<T>> for Node<T>

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

Extends a collection with the contents of an iterator.

impl<T: Hash> Hash for Node<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<'a, T: 'a> IntoIterator for &'a Node<T>

type Item = Self

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for Node<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<Node<T>> for Node<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<Node<T>> for Node<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<'a, T: 'a> Split for &'a Node<T>

type Item = &'a T

type Iter = Iter<'a, T>

fn split(self) -> (&'a T, Iter<'a, T>, u32)

impl<T: Clone> ToOwned for Node<T>

type Owned = Tree<T>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

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

recently added

Uses borrowed data to replace owned data, usually by cloning.