Tree::Ops - Tree operations.
Create a tree:
my $a = Tree::Ops::new 'a', 'A'; for(1..2) {$a->open ('b', "B$_"); $a->single('c', "C$_"); $a->close; } $a->single ('d', 'D'); $a->single ('e', 'E');
Print it:
is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 c C2 d D e E END
Navigate through the tree:
is_deeply $a->lastMost->prev->prev->first->key, 'c'; is_deeply $a->first->next->last->parent->first->value, 'C2';
Traverse the tree:
is_deeply [map{$_->value} $a->by], [qw(C1 B1 C2 B2 D E A)];
Select items from the tree:
is_deeply [map{$_->value} $a->select('b')], [qw(B1 B2)]; is_deeply [map{$_->value} $a->select(qr(b|c))], [qw(B1 C1 B2 C2)]; is_deeply [map{$_->value} $a->select(sub{$_[0] eq 'd'})], [qw(D)];
Reorganize the tree:
$a->first->next->stepEnd->stepEnd->first->next->stepBack; is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 d D c C2 e E END
Tree operations.
Version 20200725.
The following sections describe the methods in each functional area of this module. For an alphabetic listing of all methods by name see Index.
Create a tree. There is no implicit ordering applied to the tree, the relationships between parents and children within the tree are as established by the user and can be reorganized at will using the methods in this module.
Create a new child optionally recording the specified key or value.
Parameter Description 1 $key Key 2 $value Value
Example:
my $a = Tree::Ops::new 'a', 'A'; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 for(1..2) {$a->open ('b', "B$_"); $a->single('c', "C$_"); ok $a->activeScope->key eq 'b'; $a->close; } $a->single ('d', 'D'); $a->single ('e', 'E'); is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 c C2 d D e E END is_deeply [map{$_->value} $a->by], [qw(C1 B1 C2 B2 D E A)]; is_deeply $a->lastMost->prev->prev->first->key, 'c'; is_deeply $a->first->next->last->parent->first->value, 'C2'; is_deeply [map{$_->value} $a->select('b')], [qw(B1 B2)]; is_deeply [map{$_->value} $a->select(qr(b|c))], [qw(B1 C1 B2 C2)]; is_deeply [map{$_->value} $a->select(sub{$_[0] eq 'd'})], [qw(D)]; $a->first->next->stepEnd->stepEnd->first->next->stepBack; is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 d D c C2 e E END
This is a static method and so should either be imported or invoked as:
Tree::Ops::new
Locate the active scope in a tree.
Parameter Description 1 $tree Tree
my $a = Tree::Ops::new 'a', 'A'; for(1..2) {$a->open ('b', "B$_"); $a->single('c', "C$_"); ok $a->activeScope->key eq 'b'; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 $a->close; } $a->single ('d', 'D'); $a->single ('e', 'E'); is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 c C2 d D e E END is_deeply [map{$_->value} $a->by], [qw(C1 B1 C2 B2 D E A)]; is_deeply $a->lastMost->prev->prev->first->key, 'c'; is_deeply $a->first->next->last->parent->first->value, 'C2'; is_deeply [map{$_->value} $a->select('b')], [qw(B1 B2)]; is_deeply [map{$_->value} $a->select(qr(b|c))], [qw(B1 C1 B2 C2)]; is_deeply [map{$_->value} $a->select(sub{$_[0] eq 'd'})], [qw(D)]; $a->first->next->stepEnd->stepEnd->first->next->stepBack; is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 d D c C2 e E END
Add a child and make it the currently active scope into which new children will be added.
Parameter Description 1 $tree Tree 2 $key Key 3 $value Value to be recorded in the interior child being opened
my $a = Tree::Ops::new 'a', 'A'; for(1..2) {$a->open ('b', "B$_"); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 $a->single('c', "C$_"); ok $a->activeScope->key eq 'b'; $a->close; } $a->single ('d', 'D'); $a->single ('e', 'E'); is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 c C2 d D e E END is_deeply [map{$_->value} $a->by], [qw(C1 B1 C2 B2 D E A)]; is_deeply $a->lastMost->prev->prev->first->key, 'c'; is_deeply $a->first->next->last->parent->first->value, 'C2'; is_deeply [map{$_->value} $a->select('b')], [qw(B1 B2)]; is_deeply [map{$_->value} $a->select(qr(b|c))], [qw(B1 C1 B2 C2)]; is_deeply [map{$_->value} $a->select(sub{$_[0] eq 'd'})], [qw(D)]; $a->first->next->stepEnd->stepEnd->first->next->stepBack; is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 d D c C2 e E END
Close the current scope returning to the previous scope.
my $a = Tree::Ops::new 'a', 'A'; for(1..2) {$a->open ('b', "B$_"); $a->single('c', "C$_"); ok $a->activeScope->key eq 'b'; $a->close; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 } $a->single ('d', 'D'); $a->single ('e', 'E'); is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 c C2 d D e E END is_deeply [map{$_->value} $a->by], [qw(C1 B1 C2 B2 D E A)]; is_deeply $a->lastMost->prev->prev->first->key, 'c'; is_deeply $a->first->next->last->parent->first->value, 'C2'; is_deeply [map{$_->value} $a->select('b')], [qw(B1 B2)]; is_deeply [map{$_->value} $a->select(qr(b|c))], [qw(B1 C1 B2 C2)]; is_deeply [map{$_->value} $a->select(sub{$_[0] eq 'd'})], [qw(D)]; $a->first->next->stepEnd->stepEnd->first->next->stepBack; is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 d D c C2 e E END
Add one child in the current scope.
Parameter Description 1 $tree Tree 2 $key Key 3 $value Value to be recorded in the child being created
my $a = Tree::Ops::new 'a', 'A'; for(1..2) {$a->open ('b', "B$_"); $a->single('c', "C$_"); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $a->activeScope->key eq 'b'; $a->close; } $a->single ('d', 'D'); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 $a->single ('e', 'E'); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 c C2 d D e E END is_deeply [map{$_->value} $a->by], [qw(C1 B1 C2 B2 D E A)]; is_deeply $a->lastMost->prev->prev->first->key, 'c'; is_deeply $a->first->next->last->parent->first->value, 'C2'; is_deeply [map{$_->value} $a->select('b')], [qw(B1 B2)]; is_deeply [map{$_->value} $a->select(qr(b|c))], [qw(B1 C1 B2 C2)]; is_deeply [map{$_->value} $a->select(sub{$_[0] eq 'd'})], [qw(D)]; $a->first->next->stepEnd->stepEnd->first->next->stepBack; is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 d D c C2 e E END
Include the specified tree in the currently open scope.
Parameter Description 1 $tree Tree being built 2 $include Tree to include
my ($i) = fromLetters 'b(cd)'; my $a = Tree::Ops::new 'A'; $a->open ('B'); $a->include($i); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 $a->close; is_deeply $a->print, <<END; Key Value A B a b c d END
Create a tree from a string of letters returning the children created in alphabetic order - useful for testing.
Parameter Description 1 $letters String of letters and ( ).
my ($a) = fromLetters(q(bc(d)e)); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c d e END
Navigate through a tree.
Get the first child under the specified parent.
Parameter Description 1 $parent Parent
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $c->parent, $b; is_deeply $a->first, $b; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->last, $d; is_deeply $e->next, $f; is_deeply $f->prev, $e;
Get the last child under the specified parent.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $c->parent, $b; is_deeply $a->first, $b; is_deeply $a->last, $d; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $e->next, $f; is_deeply $f->prev, $e;
Get the next sibling following the specified child.
Parameter Description 1 $child Child
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $c->parent, $b; is_deeply $a->first, $b; is_deeply $a->last, $d; is_deeply $e->next, $f; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $f->prev, $e;
Get the previous sibling of the specified child.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $c->parent, $b; is_deeply $a->first, $b; is_deeply $a->last, $d; is_deeply $e->next, $f; is_deeply $f->prev, $e; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Return the first most descendant child in the tree starting at this parent or else return undef if this parent has no children.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
Return the next child with no children, i.e. the next leaf of the tree, else return undef if there is no such child.
Parameter Description 1 $child Current leaf
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $b->nextMost == $c; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $c->nextMost == $x; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $y->nextMost == $x; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $x->nextMost == $e; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $d->nextMost == $e; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $e->nextMost == $f; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $f->nextMost == $g; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $g->nextMost == $j; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $h->nextMost == $j; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $i->nextMost == $j; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$j->nextMost; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $i->topMost == $a;
Return the previous child with no children, i.e. the previous leaf of the tree, else return undef if there is no such child.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $j->prevMost == $g; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $i->prevMost == $g; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $h->prevMost == $g; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $g->prevMost == $f; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $f->prevMost == $e; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $e->prevMost == $x; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $d->prevMost == $x; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $x->prevMost == $c; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $y->prevMost == $c; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$c->prevMost; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$b->prevMost; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$a->prevMost; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
Return the last most descendant child in the tree starting at this parent or else return undef if this parent has no children.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
Return the top most parent in the tree containing the specified child.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Find the most recent common ancestor of the specified children.
Parameter Description 1 $first First child 2 $second Second child
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k) = fromLetters 'b(c(d(e))f(g(h)i)j)k'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j k END ok $e->mostRecentCommonAncestor($h) == $b; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $e->mostRecentCommonAncestor($k) == $a; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Return the child at the end of the path starting at the specified parent. A path is a list of zero based children numbers. Return undef if the path is not valid.
Parameter Description 1 $parent Parent 2 @path List of zero based children numbers
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(cd(e(fg)h)i)j'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END ok $a->go(0,1,0,1) == $g; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $d->go(0,0) == $f; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$e->path], [0,1,0]; is_deeply [$g->pathFrom($d)], [0,1]; is_deeply $b->dup->print, <<END; Key Value b c d e f g h i END my $B = $b->transcribe; $b->by(sub {my ($c) = @_; my @path = $c->pathFrom($b); my $C = $B->go(@path); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $c->key, $C->key; is_deeply $c->{transcribedTo}, $C; is_deeply $C->{transcribedFrom}, $c; }); is_deeply $B->print, <<END; Key Value b c d e f g h i END
Verify the current location.
Get the context of the current child.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $s, $t, $x, $y, $z) = fromLetters 'b(c)y(x)z(st)d(efgh(i(j))))'; is_deeply [$x->context], [$x, $y, $a]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply join(' ', $a->by(sub{$_[0]->key})), "c b x y s t z e f g j i h d a"; is_deeply join(' ', map{$_->key} $a->by), "c b x y s t z e f g j i h d a"; is_deeply $a->print, <<END; Key Value a b c y x z s t d e f g h i j END $z->cut; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END
Return the specified child if that child is first under its parent, else return undef.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END is_deeply $b->singleChildOfParent, $c; is_deeply $e->isFirst, $e; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$f->isFirst; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$g->isLast; is_deeply $h->isLast, $h; ok $j->empty; ok !$i->empty; ok $a->isTop; ok !$b->isTop;
Return the specified child if that child is last under its parent, else return undef.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END is_deeply $b->singleChildOfParent, $c; is_deeply $e->isFirst, $e; ok !$f->isFirst; ok !$g->isLast; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $h->isLast, $h; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $j->empty; ok !$i->empty; ok $a->isTop; ok !$b->isTop;
Return the specified parent if that parent is the top most parent in the tree.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END is_deeply $b->singleChildOfParent, $c; is_deeply $e->isFirst, $e; ok !$f->isFirst; ok !$g->isLast; is_deeply $h->isLast, $h; ok $j->empty; ok !$i->empty; ok $a->isTop; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$b->isTop; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Return the only child of this parent if the parent has an only child, else undef
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END is_deeply $b->singleChildOfParent, $c; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $e->isFirst, $e; ok !$f->isFirst; ok !$g->isLast; is_deeply $h->isLast, $h; ok $j->empty; ok !$i->empty; ok $a->isTop; ok !$b->isTop;
Return the specified parent if it has no children else undef
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END is_deeply $b->singleChildOfParent, $c; is_deeply $e->isFirst, $e; ok !$f->isFirst; ok !$g->isLast; is_deeply $h->isLast, $h; ok $j->empty; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$i->empty; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $a->isTop; ok !$b->isTop;
Insert children into a tree.
Place a new child first under the specified parent and return the child.
Parameter Description 1 $parent Parent 2 $child Child
my ($a, $b, $c, $d, $e) = fromLetters 'b(c)d(e)'; is_deeply $a->print, <<END; Key Value a b c d e END my $z = $b->putNext(new 'z'); is_deeply $a->print, <<END; Key Value a b c z d e END my $y = $d->putPrev(new 'y'); is_deeply $a->print, <<END; Key Value a b c z y d e END $z->putLast(new 't'); is_deeply $a->print, <<END; Key Value a b c z t y d e END $z->putFirst(new 's'); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c z s t y d e END
Place a new child last under the specified parent and return the child.
my ($a, $b, $c, $d, $e) = fromLetters 'b(c)d(e)'; is_deeply $a->print, <<END; Key Value a b c d e END my $z = $b->putNext(new 'z'); is_deeply $a->print, <<END; Key Value a b c z d e END my $y = $d->putPrev(new 'y'); is_deeply $a->print, <<END; Key Value a b c z y d e END $z->putLast(new 't'); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c z t y d e END $z->putFirst(new 's'); is_deeply $a->print, <<END; Key Value a b c z s t y d e END
Place a new child after the specified child.
Parameter Description 1 $child Existing child 2 $new New child
my ($a, $b, $c, $d, $e) = fromLetters 'b(c)d(e)'; is_deeply $a->print, <<END; Key Value a b c d e END my $z = $b->putNext(new 'z'); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c z d e END my $y = $d->putPrev(new 'y'); is_deeply $a->print, <<END; Key Value a b c z y d e END $z->putLast(new 't'); is_deeply $a->print, <<END; Key Value a b c z t y d e END $z->putFirst(new 's'); is_deeply $a->print, <<END; Key Value a b c z s t y d e END
Place a new child before the specified child.
Parameter Description 1 $child Child 2 $new New child
my ($a, $b, $c, $d, $e) = fromLetters 'b(c)d(e)'; is_deeply $a->print, <<END; Key Value a b c d e END my $z = $b->putNext(new 'z'); is_deeply $a->print, <<END; Key Value a b c z d e END my $y = $d->putPrev(new 'y'); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c z y d e END $z->putLast(new 't'); is_deeply $a->print, <<END; Key Value a b c z t y d e END $z->putFirst(new 's'); is_deeply $a->print, <<END; Key Value a b c z s t y d e END
Move the start or end of a scope forwards or backwards as suggested by Alex Monroe.
Make the first child of the specified parent the parents previous sibling and return the parent. In effect this moves the start of the parent one step forwards.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))'; $d->step; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->brackets, 'a(b(c)ed(fgh(i(j))))'; $d->stepBack; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))'; $b->stepEnd; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->brackets, 'a(b(cd(efgh(i(j)))))'; $b->stepEndBack; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))';
Make the next sibling of the specified parent the parents last child and return the parent. In effect this moves the end of the parent one step forwards.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))'; $d->step; is_deeply $a->brackets, 'a(b(c)ed(fgh(i(j))))'; $d->stepBack; is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))'; $b->stepEnd; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->brackets, 'a(b(cd(efgh(i(j)))))'; $b->stepEndBack; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))';
Make the previous sibling of the specified parent the parents first child and return the parent. In effect this moves the start of the parent one step backwards.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))'; $d->step; is_deeply $a->brackets, 'a(b(c)ed(fgh(i(j))))'; $d->stepBack; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))'; $b->stepEnd; is_deeply $a->brackets, 'a(b(cd(efgh(i(j)))))'; $b->stepEndBack; is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))';
Make the last child of the specified parent the parents next sibling and return the parent. In effect this moves the end of the parent one step backwards.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))'; $d->step; is_deeply $a->brackets, 'a(b(c)ed(fgh(i(j))))'; $d->stepBack; is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))'; $b->stepEnd; is_deeply $a->brackets, 'a(b(cd(efgh(i(j)))))'; $b->stepEndBack; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->brackets, 'a(b(c)d(efgh(i(j))))';
Edit a tree in situ.
Cut out a child and all its content and children, return it ready for reinsertion else where.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $s, $t, $x, $y, $z) = fromLetters 'b(c)y(x)z(st)d(efgh(i(j))))'; is_deeply [$x->context], [$x, $y, $a]; is_deeply join(' ', $a->by(sub{$_[0]->key})), "c b x y s t z e f g j i h d a"; is_deeply join(' ', map{$_->key} $a->by), "c b x y s t z e f g j i h d a"; is_deeply $a->print, <<END; Key Value a b c y x z s t d e f g h i j END $z->cut; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END
Duplicate a specified parent and all its descendants returning the root of the resulting tree.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(cd(e(fg)h)i)j'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END ok $a->go(0,1,0,1) == $g; ok $d->go(0,0) == $f; is_deeply [$e->path], [0,1,0]; is_deeply [$g->pathFrom($d)], [0,1]; is_deeply $b->dup->print, <<END; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 Key Value b c d e f g h i END my $B = $b->transcribe; $b->by(sub {my ($c) = @_; my @path = $c->pathFrom($b); my $C = $B->go(@path); is_deeply $c->key, $C->key; is_deeply $c->{transcribedTo}, $C; is_deeply $C->{transcribedFrom}, $c; }); is_deeply $B->print, <<END; Key Value b c d e f g h i END
Duplicate a specified parent and all its descendants recording the mapping in a temporary {transcribed} field in the tree being transcribed. Returns the root parent of the tree being duplicated.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(cd(e(fg)h)i)j'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END ok $a->go(0,1,0,1) == $g; ok $d->go(0,0) == $f; is_deeply [$e->path], [0,1,0]; is_deeply [$g->pathFrom($d)], [0,1]; is_deeply $b->dup->print, <<END; Key Value b c d e f g h i END my $B = $b->transcribe; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 $b->by(sub {my ($c) = @_; my @path = $c->pathFrom($b); my $C = $B->go(@path); is_deeply $c->key, $C->key; is_deeply $c->{transcribedTo}, $C; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $C->{transcribedFrom}, $c; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 }); is_deeply $B->print, <<END; Key Value b c d e f g h i END
Unwrap the specified child and return that child.
my ($a, $b, $c, $d, $e, $f, $g) = fromLetters 'b(c(de)f)g'; is_deeply $a->print, <<END; Key Value a b c d e f g END $c->wrap('z'); is_deeply $a->print, <<END; Key Value a b z c d e f g END $c->parent->unwrap; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c d e f g END $c->wrapChildren("Z"); is_deeply $a->print, <<END; Key Value a b c Z d e f g END
Wrap the specified child with a new parent and return the new parent optionally setting its key and value.
Parameter Description 1 $child Child to wrap 2 $key Optional key 3 $value Optional value
my ($a, $b, $c, $d, $e, $f, $g) = fromLetters 'b(c(de)f)g'; is_deeply $a->print, <<END; Key Value a b c d e f g END $c->wrap('z'); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b z c d e f g END $c->parent->unwrap; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c d e f g END $c->wrapChildren("Z"); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c Z d e f g END
Wrap the children of the specified parent with a new intermediate parent that becomes the child of the specified parent, optionally setting the key and the value for the new parent. Return the new parent.
Parameter Description 1 $parent Child to wrap 2 $key Optional key for new wrapping parent 3 $value Optional value for new wrapping parent
my ($a, $b, $c, $d, $e, $f, $g) = fromLetters 'b(c(de)f)g'; is_deeply $a->print, <<END; Key Value a b c d e f g END $c->wrap('z'); is_deeply $a->print, <<END; Key Value a b z c d e f g END $c->parent->unwrap; is_deeply $a->print, <<END; Key Value a b c d e f g END $c->wrapChildren("Z"); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c Z d e f g END
Unwrap the children of the specified parent with the whose key fields smartmatch that of their parent. Returns the specified parent regardless.
Parameter Description 1 $parent Merging parent
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END $d->split; is_deeply $a->print, <<END; Key Value a b c d d e d f d g d h i j END $f->parent->mergeLikePrev; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c d d e f d g d h i j END $g->parent->mergeLikeNext; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c d d e f d g h i j END $d->merge; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c d e f g h i j END
Merge the preceding sibling of the specified child if that sibling exists and the key data of the two siblings smartmatch. Returns the specified child regardless. From a proposal made by Micaela Monroe.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END $d->split; is_deeply $a->print, <<END; Key Value a b c d d e d f d g d h i j END $f->parent->mergeLikePrev; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c d d e f d g d h i j END $g->parent->mergeLikeNext; is_deeply $a->print, <<END; Key Value a b c d d e f d g h i j END $d->merge; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END
Merge the following sibling of the specified child if that sibling exists and the key data of the two siblings smartmatch. Returns the specified child regardless. From a proposal made by Micaela Monroe.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END $d->split; is_deeply $a->print, <<END; Key Value a b c d d e d f d g d h i j END $f->parent->mergeLikePrev; is_deeply $a->print, <<END; Key Value a b c d d e f d g d h i j END $g->parent->mergeLikeNext; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c d d e f d g h i j END $d->merge; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END
Make the specified parent a grandparent of each of its children by interposing a copy of the specified parent between the specified parent and each of its children. Return the specified parent.
Parameter Description 1 $parent Parent to make into a grand parent
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(c)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END $d->split; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c d d e d f d g d h i j END $f->parent->mergeLikePrev; is_deeply $a->print, <<END; Key Value a b c d d e f d g d h i j END $g->parent->mergeLikeNext; is_deeply $a->print, <<END; Key Value a b c d d e f d g h i j END $d->merge; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END
Traverse a tree.
Traverse a tree in post-order to process each child with the specified sub and return an array of the results of processing each child. If no sub sub is specified, the children are returned in tree order.
Parameter Description 1 $tree Tree 2 $sub Optional sub to process each child
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $s, $t, $x, $y, $z) = fromLetters 'b(c)y(x)z(st)d(efgh(i(j))))'; is_deeply [$x->context], [$x, $y, $a]; is_deeply join(' ', $a->by(sub{$_[0]->key})), "c b x y s t z e f g j i h d a"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply join(' ', map{$_->key} $a->by), "c b x y s t z e f g j i h d a"; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $a->print, <<END; Key Value a b c y x z s t d e f g h i j END $z->cut; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END
Select matching children in a tree in post-order. A child can be selected via named value, array of values, a hash of values, a regular expression or a sub reference.
Parameter Description 1 $tree Tree 2 $select Method to select a child
my $a = Tree::Ops::new 'a', 'A'; for(1..2) {$a->open ('b', "B$_"); $a->single('c', "C$_"); ok $a->activeScope->key eq 'b'; $a->close; } $a->single ('d', 'D'); $a->single ('e', 'E'); is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 c C2 d D e E END is_deeply [map{$_->value} $a->by], [qw(C1 B1 C2 B2 D E A)]; is_deeply $a->lastMost->prev->prev->first->key, 'c'; is_deeply $a->first->next->last->parent->first->value, 'C2'; is_deeply [map{$_->value} $a->select('b')], [qw(B1 B2)]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [map{$_->value} $a->select(qr(b|c))], [qw(B1 C1 B2 C2)]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [map{$_->value} $a->select(sub{$_[0] eq 'd'})], [qw(D)]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 $a->first->next->stepEnd->stepEnd->first->next->stepBack; is_deeply $a->print, <<END; Key Value a A b B1 c C1 b B2 d D c C2 e E END
Various partitions of the tree
The set of all children without further children, i.e. each leaf of the tree.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
The set of all parents in the tree, i.e. each non leaf of the tree, i.e the interior of the tree in normal pre-order.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
The set of all parents in the tree, i.e. each non leaf of the tree, i.e the interior of the tree in normal post-order.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$a->parents], [$a->parentsPostOrder]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
The set of all parents in the tree, i.e. each non leaf of the tree, i.e the interior of the tree in reverse pre-order.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
The set of all parents in the tree, i.e. each non leaf of the tree, i.e the interior of the tree in reverse post-order.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$a->parents], [$a->parentsPostOrder]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$j->parents; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
Check the order and relative position of children in a tree.
Return the first child if it is above the second child else return undef.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n) = fromLetters('b(c(d(efgh(i(j)k)l)m)n'); is_deeply $a->print, <<END; Key Value a b c d e f g h i j k l m n END ok $c->above($j) == $c; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$m->above($j); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $i->below($b) == $i; ok !$i->below($n); ok $n->after($e) == $n; ok !$k->after($c); ok $c->before($n) == $c; ok !$c->before($m); is_deeply [map{$_->key} $j->lineage($d)], [qw(j i h d)]; ok !$d->lineage($m);
Return the first child if it is below the second child else return undef.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n) = fromLetters('b(c(d(efgh(i(j)k)l)m)n'); is_deeply $a->print, <<END; Key Value a b c d e f g h i j k l m n END ok $c->above($j) == $c; ok !$m->above($j); ok $i->below($b) == $i; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$i->below($n); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $n->after($e) == $n; ok !$k->after($c); ok $c->before($n) == $c; ok !$c->before($m); is_deeply [map{$_->key} $j->lineage($d)], [qw(j i h d)]; ok !$d->lineage($m);
Return the first child if it occurs strictly after the second child in the tree or else undef if the first child is above, below or before the second child.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n) = fromLetters('b(c(d(efgh(i(j)k)l)m)n'); is_deeply $a->print, <<END; Key Value a b c d e f g h i j k l m n END ok $c->above($j) == $c; ok !$m->above($j); ok $i->below($b) == $i; ok !$i->below($n); ok $n->after($e) == $n; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$k->after($c); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $c->before($n) == $c; ok !$c->before($m); is_deeply [map{$_->key} $j->lineage($d)], [qw(j i h d)]; ok !$d->lineage($m);
Return the first child if it occurs strictly before the second child in the tree or else undef if the first child is above, below or after the second child.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n) = fromLetters('b(c(d(efgh(i(j)k)l)m)n'); is_deeply $a->print, <<END; Key Value a b c d e f g h i j k l m n END ok $c->above($j) == $c; ok !$m->above($j); ok $i->below($b) == $i; ok !$i->below($n); ok $n->after($e) == $n; ok !$k->after($c); ok $c->before($n) == $c; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$c->before($m); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [map{$_->key} $j->lineage($d)], [qw(j i h d)]; ok !$d->lineage($m);
Find paths between nodes
Return the list of zero based child indexes for the path from the root of the tree containing the specified child to the specified child for use by the go method.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(cd(e(fg)h)i)j'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END ok $a->go(0,1,0,1) == $g; ok $d->go(0,0) == $f; is_deeply [$e->path], [0,1,0]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$g->pathFrom($d)], [0,1]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $b->dup->print, <<END; Key Value b c d e f g h i END my $B = $b->transcribe; $b->by(sub {my ($c) = @_; my @path = $c->pathFrom($b); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 my $C = $B->go(@path); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $c->key, $C->key; is_deeply $c->{transcribedTo}, $C; is_deeply $C->{transcribedFrom}, $c; }); is_deeply $B->print, <<END; Key Value b c d e f g h i END
Return the list of zero based child indexes for the path from the specified ancestor to the specified child for use by the go method else confess if the ancestor is not, in fact, an ancestor.
Parameter Description 1 $child Child 2 $ancestor Ancestor
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(cd(e(fg)h)i)j'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END ok $a->go(0,1,0,1) == $g; ok $d->go(0,0) == $f; is_deeply [$e->path], [0,1,0]; is_deeply [$g->pathFrom($d)], [0,1]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply $b->dup->print, <<END; Key Value b c d e f g h i END my $B = $b->transcribe; $b->by(sub {my ($c) = @_; my @path = $c->pathFrom($b); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 my $C = $B->go(@path); is_deeply $c->key, $C->key; is_deeply $c->{transcribedTo}, $C; is_deeply $C->{transcribedFrom}, $c; }); is_deeply $B->print, <<END; Key Value b c d e f g h i END
Return a list of siblings before the specified child.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(cde(f)ghi)j'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END is_deeply [$d->siblingsStrictlyBetween($h)], [$e, $g]; is_deeply [$d->siblingsAfter], [$e, $g, $h, $i]; is_deeply [$g->siblingsBefore], [$c, $d, $e]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 eval {$e->siblingsStrictlyBetween($f)}; ok $@ =~ m(Must be siblings);
Return a list of siblings after the specified child.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(cde(f)ghi)j'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END is_deeply [$d->siblingsStrictlyBetween($h)], [$e, $g]; is_deeply [$d->siblingsAfter], [$e, $g, $h, $i]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$g->siblingsBefore], [$c, $d, $e]; eval {$e->siblingsStrictlyBetween($f)}; ok $@ =~ m(Must be siblings);
Return a list of the siblings strictly between two children of the same parent else return undef.
Parameter Description 1 $start Start child 2 $finish Finish child
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j) = fromLetters 'b(cde(f)ghi)j'; is_deeply $a->print, <<END; Key Value a b c d e f g h i j END is_deeply [$d->siblingsStrictlyBetween($h)], [$e, $g]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 is_deeply [$d->siblingsAfter], [$e, $g, $h, $i]; is_deeply [$g->siblingsBefore], [$c, $d, $e]; eval {$e->siblingsStrictlyBetween($f)}; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok $@ =~ m(Must be siblings);
Return the path from the specified child to the specified ancestor else return undef if the child is not a descendant of the ancestor.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n) = fromLetters('b(c(d(efgh(i(j)k)l)m)n'); is_deeply $a->print, <<END; Key Value a b c d e f g h i j k l m n END ok $c->above($j) == $c; ok !$m->above($j); ok $i->below($b) == $i; ok !$i->below($n); ok $n->after($e) == $n; ok !$k->after($c); ok $c->before($n) == $c; ok !$c->before($m); is_deeply [map{$_->key} $j->lineage($d)], [qw(j i h d)]; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 ok !$d->lineage($m); # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲
Return a list of children visited between the specified child and the next child in pre-order.
Parameter Description 1 $start The child at the start of the path
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n, $o, $p, $q, $r) = fromLetters 'b(c(d(e(fg)hi(j(kl)m)n)op)q)r'; my @p = [$a]; for(1..99) {my @n = $p[-1][-1]->nextPreOrderPath; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 last unless @n; push @p, [@n]; } is_deeply $a->print, <<END; Key Value a b c d e f g h i j k l m n o p q r END my @pre = map{[map{$_->key} @$_]} @p; is_deeply scalar(@pre), scalar(['a'..'r']->@*); is_deeply [@pre], [["a"], ["b"], ["c"], ["d"], ["e"], ["f"], ["g"], ["e", "h"], ["i"], ["j"], ["k"], ["l"], ["j", "m"], ["i", "n"], ["d", "o"], ["p"], ["c", "q"], ["b", "r"]];
Return a list of children visited between the specified child and the next child in post-order.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n, $o, $p, $q, $r) = fromLetters 'b(c(d(e(fg)hi(j(kl)m)n)op)q)r'; my @n = $a; my @p; for(1..99) {@n = $n[-1]->nextPostOrderPath; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 last unless @n; push @p, [@n]; last if $n[-1] == $a; } is_deeply $a->print, <<END; Key Value a b c d e f g h i j k l m n o p q r END my @post = map{[map{$_->key} @$_]} @p; is_deeply scalar(@post), scalar(['a'..'r']->@*); is_deeply [@post], [["b" .. "f"], ["g"], ["e"], ["h"], ["i", "j", "k"], ["l"], ["j"], ["m"], ["i"], ["n"], ["d"], ["o"], ["p"], ["c"], ["q"], ["b"], ["r"], ["a"]];
Return a list of children visited between the specified child and the previous child in post-order.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n, $o, $p, $q, $r) = fromLetters 'b(c(d(e(fg)hi(j(kl)m)n)op)q)r'; my @p = [$a]; for(1..99) {my @n = $p[-1][-1]->prevPostOrderPath; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 last unless @n; push @p, [@n]; } is_deeply $a->print, <<END; Key Value a b c d e f g h i j k l m n o p q r END my @post = map{[map{$_->key} @$_]} @p; is_deeply scalar(@post), scalar(['a'..'r']->@*); is_deeply [@post], [["a"], ["r"], ["b"], ["q"], ["c"], ["p"], ["o"], ["d"], ["n"], ["i"], ["m"], ["j"], ["l"], ["k"], ["j", "i", "h"], ["e"], ["g"], ["f"]];
Return a list of children visited between the specified child and the previous child in pre-order.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $k, $l, $m, $n, $o, $p, $q, $r) = fromLetters 'b(c(d(e(fg)hi(j(kl)m)n)op)q)r'; my @n = $a; my @p; for(1..99) {@n = $n[-1]->prevPreOrderPath; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 last unless @n; push @p, [@n]; last if $n[-1] == $a; } is_deeply $a->print, <<END; Key Value a b c d e f g h i j k l m n o p q r END my @pre = map{[map{$_->key} @$_]} @p; is_deeply scalar(@pre), scalar(['a'..'r']->@*); is_deeply [@pre], [["r"], ["b", "q"], ["c", "p"], ["o"], ["d", "n"], ["i", "m"], ["j", "l"], ["k"], ["j"], ["i"], ["h"], ["e", "g"], ["f"], ["e"], ["d"], ["c"], ["b"], ["a"]];
Print a tree.
Print tree in normal pre-order.
Parameter Description 1 $tree Tree 2 $print Optional print method
my ($a, $b, $c, $d) = fromLetters 'b(c)d'; my sub test(@) {join ' ', map{join '', $_->key} @_} is_deeply $a->printPreOrder, <<END; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 Key Value a b c d END is_deeply test($a->nextPreOrderPath), 'b'; is_deeply test($b->nextPreOrderPath), 'c'; is_deeply test($c->nextPreOrderPath), 'b d'; is_deeply test($d->nextPreOrderPath), ''; is_deeply $a->printPostOrder, <<END; Key Value c b d a END is_deeply test($a->nextPostOrderPath), 'b c'; is_deeply test($c->nextPostOrderPath), 'b'; is_deeply test($b->nextPostOrderPath), 'd'; is_deeply test($d->nextPostOrderPath), 'a'; is_deeply $a->printReversePreOrder, <<END; Key Value a d b c END is_deeply test($a->prevPreOrderPath), 'd'; is_deeply test($d->prevPreOrderPath), 'b c'; is_deeply test($c->prevPreOrderPath), 'b'; is_deeply test($b->prevPreOrderPath), 'a'; is_deeply $a->printReversePostOrder, <<END; Key Value d c b a END is_deeply test($a->prevPostOrderPath), 'd'; is_deeply test($d->prevPostOrderPath), 'b'; is_deeply test($b->prevPostOrderPath), 'c'; is_deeply test($c->prevPostOrderPath), '';
Print tree in normal post-order.
my ($a, $b, $c, $d) = fromLetters 'b(c)d'; my sub test(@) {join ' ', map{join '', $_->key} @_} is_deeply $a->printPreOrder, <<END; Key Value a b c d END is_deeply test($a->nextPreOrderPath), 'b'; is_deeply test($b->nextPreOrderPath), 'c'; is_deeply test($c->nextPreOrderPath), 'b d'; is_deeply test($d->nextPreOrderPath), ''; is_deeply $a->printPostOrder, <<END; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 Key Value c b d a END is_deeply test($a->nextPostOrderPath), 'b c'; is_deeply test($c->nextPostOrderPath), 'b'; is_deeply test($b->nextPostOrderPath), 'd'; is_deeply test($d->nextPostOrderPath), 'a'; is_deeply $a->printReversePreOrder, <<END; Key Value a d b c END is_deeply test($a->prevPreOrderPath), 'd'; is_deeply test($d->prevPreOrderPath), 'b c'; is_deeply test($c->prevPreOrderPath), 'b'; is_deeply test($b->prevPreOrderPath), 'a'; is_deeply $a->printReversePostOrder, <<END; Key Value d c b a END is_deeply test($a->prevPostOrderPath), 'd'; is_deeply test($d->prevPostOrderPath), 'b'; is_deeply test($b->prevPostOrderPath), 'c'; is_deeply test($c->prevPostOrderPath), '';
Print tree in reverse pre-order
my ($a, $b, $c, $d) = fromLetters 'b(c)d'; my sub test(@) {join ' ', map{join '', $_->key} @_} is_deeply $a->printPreOrder, <<END; Key Value a b c d END is_deeply test($a->nextPreOrderPath), 'b'; is_deeply test($b->nextPreOrderPath), 'c'; is_deeply test($c->nextPreOrderPath), 'b d'; is_deeply test($d->nextPreOrderPath), ''; is_deeply $a->printPostOrder, <<END; Key Value c b d a END is_deeply test($a->nextPostOrderPath), 'b c'; is_deeply test($c->nextPostOrderPath), 'b'; is_deeply test($b->nextPostOrderPath), 'd'; is_deeply test($d->nextPostOrderPath), 'a'; is_deeply $a->printReversePreOrder, <<END; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 Key Value a d b c END is_deeply test($a->prevPreOrderPath), 'd'; is_deeply test($d->prevPreOrderPath), 'b c'; is_deeply test($c->prevPreOrderPath), 'b'; is_deeply test($b->prevPreOrderPath), 'a'; is_deeply $a->printReversePostOrder, <<END; Key Value d c b a END is_deeply test($a->prevPostOrderPath), 'd'; is_deeply test($d->prevPostOrderPath), 'b'; is_deeply test($b->prevPostOrderPath), 'c'; is_deeply test($c->prevPostOrderPath), '';
Print tree in reverse post-order
my ($a, $b, $c, $d) = fromLetters 'b(c)d'; my sub test(@) {join ' ', map{join '', $_->key} @_} is_deeply $a->printPreOrder, <<END; Key Value a b c d END is_deeply test($a->nextPreOrderPath), 'b'; is_deeply test($b->nextPreOrderPath), 'c'; is_deeply test($c->nextPreOrderPath), 'b d'; is_deeply test($d->nextPreOrderPath), ''; is_deeply $a->printPostOrder, <<END; Key Value c b d a END is_deeply test($a->nextPostOrderPath), 'b c'; is_deeply test($c->nextPostOrderPath), 'b'; is_deeply test($b->nextPostOrderPath), 'd'; is_deeply test($d->nextPostOrderPath), 'a'; is_deeply $a->printReversePreOrder, <<END; Key Value a d b c END is_deeply test($a->prevPreOrderPath), 'd'; is_deeply test($d->prevPreOrderPath), 'b c'; is_deeply test($c->prevPreOrderPath), 'b'; is_deeply test($b->prevPreOrderPath), 'a'; is_deeply $a->printReversePostOrder, <<END; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 Key Value d c b a END is_deeply test($a->prevPostOrderPath), 'd'; is_deeply test($d->prevPostOrderPath), 'b'; is_deeply test($b->prevPostOrderPath), 'c'; is_deeply test($c->prevPostOrderPath), '';
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
Bracketed string representation of a tree.
Parameter Description 1 $tree Tree 2 $print Optional print method 3 $separator Optional child separator
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
Print a tree as as xml.
my ($a, $b, $c, $d, $e, $f, $g, $h, $i, $j, $x, $y) = fromLetters 'b(c)y(x)d(efgh(i(j)))'; is_deeply $a->print, <<END; Key Value a b c y x d e f g h i j END is_deeply $a->xml, # 𝗘𝘅𝗮𝗺𝗽𝗹𝗲 '<a><b><c/></b><y><x/></y><d><e/><f/><g/><h><i><j/></i></h></d></a>'; is_deeply [$c, $x, $e, $f, $g, $j], [$a->leaves]; is_deeply [$a, $b, $y, $d, $h, $i], [$a->parentsPreOrder]; is_deeply [$b, $y, $i, $h, $d, $a], [$a->parentsPostOrder]; is_deeply [$a->parents], [$a->parentsPostOrder]; is_deeply [$a, $d, $h, $i, $y, $b], [$a->parentsReversePreOrder]; is_deeply [$i, $h, $d, $y, $b, $a], [$a->parentsReversePostOrder]; ok !$j->parents; ok $a->lastMost == $j; ok !$a->prevMost; ok $j->prevMost == $g; ok $i->prevMost == $g; ok $h->prevMost == $g; ok $g->prevMost == $f; ok $f->prevMost == $e; ok $e->prevMost == $x; ok $d->prevMost == $x; ok $x->prevMost == $c; ok $y->prevMost == $c; ok !$c->prevMost; ok !$b->prevMost; ok !$a->prevMost; ok $a->firstMost == $c; ok $a->nextMost == $c; ok $b->nextMost == $c; ok $c->nextMost == $x; ok $y->nextMost == $x; ok $x->nextMost == $e; ok $d->nextMost == $e; ok $e->nextMost == $f; ok $f->nextMost == $g; ok $g->nextMost == $j; ok $h->nextMost == $j; ok $i->nextMost == $j; ok !$j->nextMost; ok $i->topMost == $a;
Data structures use by this package.
Child in the tree.
Children of this child.
Key for this child - any thing that can be compared with the smartmatch operator.
Last active child chain - enables us to find the currently open scope from the start if the tree.
Parent for this child.
Value for this child.
Set the parent of a child and return the child.
Parameter Description 1 $child Child 2 $parent Parent
Get the index of a child within the specified parent.
The set of all parents in the tree, i.e. each non leaf of the tree, i.e the interior of the tree in the specified order.
Parameter Description 1 $tree Tree 2 $preorder Pre-order if true else post-order 3 $reverse Reversed if true
String representation as a horizontal tree.
Parameter Description 1 $tree Tree 2 $print Optional print method 3 $preorder Pre-order 4 $reverse Reverse
1 above - Return the first child if it is above the second child else return undef.
2 activeScope - Locate the active scope in a tree.
3 after - Return the first child if it occurs strictly after the second child in the tree or else undef if the first child is above, below or before the second child.
4 before - Return the first child if it occurs strictly before the second child in the tree or else undef if the first child is above, below or after the second child.
5 below - Return the first child if it is below the second child else return undef.
6 brackets - Bracketed string representation of a tree.
7 by - Traverse a tree in post-order to process each child with the specified sub and return an array of the results of processing each child.
8 close - Close the current scope returning to the previous scope.
9 context - Get the context of the current child.
10 cut - Cut out a child and all its content and children, return it ready for reinsertion else where.
11 dup - Duplicate a specified parent and all its descendants returning the root of the resulting tree.
12 empty - Return the specified parent if it has no children else undef
13 first - Get the first child under the specified parent.
14 firstMost - Return the first most descendant child in the tree starting at this parent or else return undef if this parent has no children.
15 fromLetters - Create a tree from a string of letters returning the children created in alphabetic order - useful for testing.
16 go - Return the child at the end of the path starting at the specified parent.
17 include - Include the specified tree in the currently open scope.
18 indexOfChildInParent - Get the index of a child within the specified parent.
19 isFirst - Return the specified child if that child is first under its parent, else return undef.
20 isLast - Return the specified child if that child is last under its parent, else return undef.
21 isTop - Return the specified parent if that parent is the top most parent in the tree.
22 last - Get the last child under the specified parent.
23 lastMost - Return the last most descendant child in the tree starting at this parent or else return undef if this parent has no children.
24 leaves - The set of all children without further children, i.
25 lineage - Return the path from the specified child to the specified ancestor else return undef if the child is not a descendant of the ancestor.
26 merge - Unwrap the children of the specified parent with the whose key fields smartmatch that of their parent.
27 mergeLikeNext - Merge the following sibling of the specified child if that sibling exists and the key data of the two siblings smartmatch.
28 mergeLikePrev - Merge the preceding sibling of the specified child if that sibling exists and the key data of the two siblings smartmatch.
29 mostRecentCommonAncestor - Find the most recent common ancestor of the specified children.
30 new - Create a new child optionally recording the specified key or value.
31 next - Get the next sibling following the specified child.
32 nextMost - Return the next child with no children, i.
33 nextPostOrderPath - Return a list of children visited between the specified child and the next child in post-order.
34 nextPreOrderPath - Return a list of children visited between the specified child and the next child in pre-order.
35 open - Add a child and make it the currently active scope into which new children will be added.
36 parents - The set of all parents in the tree, i.
37 parentsOrdered - The set of all parents in the tree, i.
38 parentsPostOrder - The set of all parents in the tree, i.
39 parentsPreOrder - The set of all parents in the tree, i.
40 parentsReversePostOrder - The set of all parents in the tree, i.
41 parentsReversePreOrder - The set of all parents in the tree, i.
42 path - Return the list of zero based child indexes for the path from the root of the tree containing the specified child to the specified child for use by the go method.
43 pathFrom - Return the list of zero based child indexes for the path from the specified ancestor to the specified child for use by the go method else confess if the ancestor is not, in fact, an ancestor.
44 prev - Get the previous sibling of the specified child.
45 prevMost - Return the previous child with no children, i.
46 prevPostOrderPath - Return a list of children visited between the specified child and the previous child in post-order.
47 prevPreOrderPath - Return a list of children visited between the specified child and the previous child in pre-order.
48 print - Print tree in normal pre-order.
49 printPostOrder - Print tree in normal post-order.
50 printPreOrder - Print tree in normal pre-order.
51 printReversePostOrder - Print tree in reverse post-order
52 printReversePreOrder - Print tree in reverse pre-order
53 printTree - String representation as a horizontal tree.
54 putFirst - Place a new child first under the specified parent and return the child.
55 putLast - Place a new child last under the specified parent and return the child.
56 putNext - Place a new child after the specified child.
57 putPrev - Place a new child before the specified child.
58 select - Select matching children in a tree in post-order.
59 setParentOfChild - Set the parent of a child and return the child.
60 siblingsAfter - Return a list of siblings after the specified child.
61 siblingsBefore - Return a list of siblings before the specified child.
62 siblingsStrictlyBetween - Return a list of the siblings strictly between two children of the same parent else return undef.
63 single - Add one child in the current scope.
64 singleChildOfParent - Return the only child of this parent if the parent has an only child, else undef
65 split - Make the specified parent a grandparent of each of its children by interposing a copy of the specified parent between the specified parent and each of its children.
66 step - Make the first child of the specified parent the parents previous sibling and return the parent.
67 stepBack - Make the previous sibling of the specified parent the parents first child and return the parent.
68 stepEnd - Make the next sibling of the specified parent the parents last child and return the parent.
69 stepEndBack - Make the last child of the specified parent the parents next sibling and return the parent.
70 topMost - Return the top most parent in the tree containing the specified child.
71 transcribe - Duplicate a specified parent and all its descendants recording the mapping in a temporary {transcribed} field in the tree being transcribed.
72 unwrap - Unwrap the specified child and return that child.
73 wrap - Wrap the specified child with a new parent and return the new parent optionally setting its key and value.
74 wrapChildren - Wrap the children of the specified parent with a new intermediate parent that becomes the child of the specified parent, optionally setting the key and the value for the new parent.
75 xml - Print a tree as as xml.
This module is written in 100% Pure Perl and, thus, it is easy to read, comprehend, use, modify and install via cpan:
sudo cpan install Tree::Ops
philiprbrenan@gmail.com
http://www.appaapps.com
Copyright (c) 2016-2019 Philip R Brenan.
This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
To install Tree::Ops, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tree::Ops
CPAN shell
perl -MCPAN -e shell install Tree::Ops
For more information on module installation, please visit the detailed CPAN module installation guide.