[−][src]Struct trees::walk::TreeWalk

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

Depth first search in tree.

Implementations

`impl<T> TreeWalk<T>`[src]

`pub fn get(&self) -> Option<Visit<'_, T>>`[src]

Returns the current node in the tree traversal, or None if the traversal is completed.

Examples

use trees::{TreeWalk, tr, walk::Visit};
let tree = tr(0) / tr(1)/tr(2)/tr(3);
let walk = TreeWalk::from( tree );
assert_eq!( walk.get(), Some( Visit::Begin( ( tr(0)/tr(1)/tr(2)/tr(3) ).root() )));

`pub fn forward(&mut self)`[src]

Depth first search on TreeWalk. Preorder or postorder at will.

Examples

use trees::{TreeWalk, tr, walk::Visit};
let tree = tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) );
let mut walk = TreeWalk::from( tree );
assert_eq!( walk.get(), Some( Visit::Begin( ( tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) ) ).root() )));
walk.forward();
assert_eq!( walk.get(), Some( Visit::Begin( (tr(1)/tr(2)/tr(3)).root() )));
walk.forward();
assert_eq!( walk.get(), Some( Visit::Leaf ( tr(2).root() )));
walk.forward();
assert_eq!( walk.get(), Some( Visit::Leaf ( tr(3).root() )));
walk.forward();
assert_eq!( walk.get(), Some( Visit::End  ( (tr(1)/tr(2)/tr(3)).root() )));
walk.forward();
assert_eq!( walk.get(), Some( Visit::Begin( (tr(4)/tr(5)/tr(6)).root() )));
walk.forward();
assert_eq!( walk.get(), Some( Visit::Leaf ( tr(5).root() )));
walk.forward();
assert_eq!( walk.get(), Some( Visit::Leaf ( tr(6).root() )));
walk.forward();
assert_eq!( walk.get(), Some( Visit::End  ( (tr(4)/tr(5)/tr(6)).root() )));
walk.forward();
assert_eq!( walk.get(), Some( Visit::End  ( ( tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) ) ).root() )));
walk.forward();
assert_eq!( walk.get(), None );
walk.forward();
assert_eq!( walk.get(), None );

`pub fn next(&mut self) -> Option<Visit<'_, T>>`[src]

Advance the cursor and return the newly visited node.

NOTICE: the FIRST node in the traversal can NOT be accessed via next() call.

Examples

use trees::{TreeWalk, tr, walk::Visit};
let tree = tr(0) / tr(1)/tr(2)/tr(3);
let mut walk = TreeWalk::from( tree );
assert_eq!( walk.next(), Some( Visit::Leaf( tr(1).root() )));
assert_eq!( walk.next(), Some( Visit::Leaf( tr(2).root() )));
assert_eq!( walk.next(), Some( Visit::Leaf( tr(3).root() )));
assert_eq!( walk.next(), Some( Visit::End( ( tr(0)/tr(1)/tr(2)/tr(3) ).root() )));
assert_eq!( walk.next(), None );
assert_eq!( walk.next(), None );

`pub fn to_parent(&mut self) -> Option<Visit<'_, T>>`[src]

Set the cursor to the current node's parent and returns it, or None if it has no parent.

Examples

use trees::{TreeWalk, tr, walk::Visit};
let tree = tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) );
let mut walk = TreeWalk::from( tree );
assert_eq!( walk.get(), Some( Visit::Begin( ( tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) ) ).root() )));
walk.forward();
assert_eq!( walk.get(), Some( Visit::Begin( (tr(1)/tr(2)/tr(3)).root() )));
assert_eq!( walk.to_parent(), Some( Visit::End( ( tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) ) ).root() )));

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

Returns the parent of current node, or None if it has no parent.

Examples

use trees::{TreeWalk, tr, walk::Visit};
let tree = tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) );
let mut walk = TreeWalk::from( tree );
assert_eq!( walk.get(), Some( Visit::Begin( ( tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) ) ).root() )));
assert_eq!( walk.get_parent(), None );
walk.forward();
assert_eq!( walk.get(), Some( Visit::Begin( (tr(1)/tr(2)/tr(3)).root() )));
assert_eq!( walk.get_parent(), Some( ( tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) ) ).root() ));

`pub fn to_child(&mut self, n: usize) -> Option<Visit<'_, T>>`[src]

Sets the cursor to the current node's n-th child and returns it, or None if it has no child. Notice that n == 0 indicating the first child.

Examples

use trees::{TreeWalk, tr, walk::Visit};
let tree = tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) );
let mut walk = TreeWalk::from( tree );
assert_eq!( walk.get(), Some( Visit::Begin( ( tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) ) ).root() )));
walk.to_child( 1 );
assert_eq!( walk.get(), Some( Visit::Begin( (tr(4)/tr(5)/tr(6)).root() )));

`pub fn to_sib(&mut self, n: usize) -> Option<Visit<'_, T>>`[src]

Sets the cursor to the current node's next n-th sibling and returns it, or None if such sibling does not exist. Returns the current node if n == 0.

Examples

use trees::{TreeWalk, tr, walk::Visit};
let tree = tr(0) / tr(1)/tr(2)/tr(3);
let mut walk = TreeWalk::from( tree );
assert_eq!( walk.next(), Some( Visit::Leaf( tr(1).root() )));
assert_eq!( walk.to_sib( 0 ), Some( Visit::Leaf( tr(1).root() )));
assert_eq!( walk.to_sib( 2 ), Some( Visit::Leaf( tr(3).root() )));

`pub fn revisit(&mut self)`[src]

Revisits a Node that reached Visit::End. No effect on Visit::Begin or Visit::Leaf.

Examples

use trees::{TreeWalk, tr, walk::Visit};
let tree = tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) );
let mut walk = TreeWalk::from( tree );
for _ in 0..3 {
    for _ in 0..3 {
        walk.revisit();
        assert_eq!( walk.get(), Some( Visit::Begin( ( tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) ) ).root() )));
        walk.forward();
        for _ in 0..3 {
            walk.revisit();
            assert_eq!( walk.get(), Some( Visit::Begin( (tr(1)/tr(2)/tr(3)).root() )));
            walk.forward();
            assert_eq!( walk.get(), Some( Visit::Leaf ( tr(2).root() )));
            walk.forward();
            assert_eq!( walk.get(), Some( Visit::Leaf ( tr(3).root() )));
            walk.forward();
            assert_eq!( walk.get(), Some( Visit::End  ( (tr(1)/tr(2)/tr(3)).root() )));
        }
        walk.forward();
        for _ in 0..3 {
            walk.revisit();
            assert_eq!( walk.get(), Some( Visit::Begin( (tr(4)/tr(5)/tr(6)).root() )));
            walk.forward();
            assert_eq!( walk.get(), Some( Visit::Leaf ( tr(5).root() )));
            walk.forward();
            assert_eq!( walk.get(), Some( Visit::Leaf ( tr(6).root() )));
            walk.forward();
            assert_eq!( walk.get(), Some( Visit::End  ( (tr(4)/tr(5)/tr(6)).root() )));
        }
        walk.forward();
        assert_eq!( walk.get(), Some( Visit::End  ( ( tr(0) /( tr(1)/tr(2)/tr(3) ) /( tr(4)/tr(5)/tr(6) ) ).root() )));
    }
    walk.forward();
    assert_eq!( walk.get(), None );
    walk.forward();
    assert_eq!( walk.get(), None );
}

Trait Implementations

`impl<T> From<Tree<T>> for TreeWalk<T>`[src]

`fn from(tree: Tree<T>) -> Self`[src]

`impl<T> From<TreeWalk<T>> for Tree<T>`[src]

`fn from(walk: TreeWalk<T>) -> Self`[src]

`impl<T: Send> Send for TreeWalk<T>`[src]

`impl<T: Sync> Sync for TreeWalk<T>`[src]

Auto Trait Implementations

`impl<T> !RefUnwindSafe for TreeWalk<T>`[src]

`impl<T> Unpin for TreeWalk<T> where T: Unpin,` [src]

`impl<T> !UnwindSafe for TreeWalk<T>`[src]

Blanket Implementations

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

`pub fn type_id(&self) -> TypeId`[src]

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

`pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut I impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;`[src]

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

`pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut I impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;`[src]

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

`pub fn from(t: T) -> T`[src]

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

`pub fn into(self) -> U`[src]

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

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

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

`type Error = >::Error`

The type returned in the event of a conversion error.

[−][src]Struct trees::walk::TreeWalk

Implementations

impl<T> TreeWalk<T>[src]

pub fn get(&self) -> Option<Visit<'_, T>>[src]

pub fn forward(&mut self)[src]

pub fn next(&mut self) -> Option<Visit<'_, T>>[src]

pub fn to_parent(&mut self) -> Option<Visit<'_, T>>[src]

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

pub fn to_child(&mut self, n: usize) -> Option<Visit<'_, T>>[src]

pub fn to_sib(&mut self, n: usize) -> Option<Visit<'_, T>>[src]

pub fn revisit(&mut self)[src]

Trait Implementations

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

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

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

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

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

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

Auto Trait Implementations

impl<T> !RefUnwindSafe for TreeWalk<T>[src]

impl<T> Unpin for TreeWalk<T> where T: Unpin, [src]

impl<T> !UnwindSafe for TreeWalk<T>[src]

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

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

pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut Iimpl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;[src]

Notable traits for &'_ mut I

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

pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut Iimpl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;[src]

Notable traits for &'_ mut I

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

pub fn from(t: T) -> T[src]

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

pub fn into(self) -> U[src]

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

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

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

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<T> TupleTree<T, ()> for T[src]

pub const SIZE: Size[src]

pub fn descendants(usize) -> usize[src]

pub fn height() -> usize[src]

pub fn preorder(Self, &mut impl FnMut(Visit<T>))[src]

pub fn preorder_with_size_hint(Self, &mut impl FnMut(Visit<T>, Size))[src]

pub fn postorder(Self, &mut impl FnMut(Visit<T>))[src]

pub fn postorder_with_size_hint(Self, &mut impl FnMut(Visit<T>, Size))[src]

`impl<T> TreeWalk<T>`[src]

`pub fn get(&self) -> Option<Visit<'_, T>>`[src]

`pub fn forward(&mut self)`[src]

`pub fn next(&mut self) -> Option<Visit<'_, T>>`[src]

`pub fn to_parent(&mut self) -> Option<Visit<'_, T>>`[src]

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

`pub fn to_child(&mut self, n: usize) -> Option<Visit<'_, T>>`[src]

`pub fn to_sib(&mut self, n: usize) -> Option<Visit<'_, T>>`[src]

`pub fn revisit(&mut self)`[src]

`impl<T> From<Tree<T>> for TreeWalk<T>`[src]

`fn from(tree: Tree<T>) -> Self`[src]

`impl<T> From<TreeWalk<T>> for Tree<T>`[src]

`fn from(walk: TreeWalk<T>) -> Self`[src]

`impl<T: Send> Send for TreeWalk<T>`[src]

`impl<T: Sync> Sync for TreeWalk<T>`[src]

`impl<T> !RefUnwindSafe for TreeWalk<T>`[src]

`impl<T> Unpin for TreeWalk<T> where T: Unpin,` [src]

`impl<T> !UnwindSafe for TreeWalk<T>`[src]

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

`pub fn type_id(&self) -> TypeId`[src]

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

`pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut I impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`[src]

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

`pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut I impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`[src]

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

`pub fn from(t: T) -> T`[src]

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

`pub fn into(self) -> U`[src]

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

`type Error = Infallible`

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

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

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

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

`impl<T> TupleTree<T, ()> for T`[src]

`pub const SIZE: Size`[src]

`pub fn descendants(usize) -> usize`[src]

`pub fn height() -> usize`[src]

`pub fn preorder(Self, &mut impl FnMut(Visit<T>))`[src]

`pub fn preorder_with_size_hint(Self, &mut impl FnMut(Visit<T>, Size))`[src]

`pub fn postorder(Self, &mut impl FnMut(Visit<T>))`[src]

`pub fn postorder_with_size_hint(Self, &mut impl FnMut(Visit<T>, Size))`[src]