GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  FOREST::TREE (3)

.ds Aq ’

NAME

Forest::Tree - An n-ary tree

CONTENTS

SYNOPSIS



  use Forest::Tree;

  my $t = Forest::Tree->new(
      node     => 1,
      children => [
          Forest::Tree->new(
              node     => 1.1,
              children => [
                  Forest::Tree->new(node => 1.1.1),
                  Forest::Tree->new(node => 1.1.2),
                  Forest::Tree->new(node => 1.1.3),
              ]
          ),
          Forest::Tree->new(node => 1.2),
          Forest::Tree->new(
              node     => 1.3,
              children => [
                  Forest::Tree->new(node => 1.3.1),
                  Forest::Tree->new(node => 1.3.2),
              ]
          ),
      ]
  );

  $t->traverse(sub {
      my $t = shift;
      print((     x $t->depth) . ($t->node || \undef) . "\n");
  });



DESCRIPTION

This module is a basic n-ary tree, it provides most of the functionality of Tree::Simple, whatever is missing will be added eventually.

This class inherits from Forest::Tree::Pure>, but all shared methods and attributes are documented in both classes.

ATTRIBUTES

node
uid
parent
<B>parentB>
<B>_set_parentB>
<B>has_parentB>
<B>clear_parentB>
children
<B>get_child_at ($index)B> Return the child at this position. (zero-base index)
<B>child_countB> Returns the number of children this tree has
size
<B>sizeB>
<B>has_sizeB>
<B>clear_sizeB>
height
<B>heightB>
<B>has_heightB>
<B>clear_heightB>

METHODS

<B>is_rootB> True if the current tree has no parent
<B>is_leafB> True if the current tree has no children
<B>depthB> Return the depth of this tree. Root has a depth of -1
<B>add_child ($child)B>
<B>add_children (@children)B> Add a new child. The $child must be a Forest::Tree
<B>insert_child_at ($index, B>$child<B>)B> Insert a child at this position. (zero-base index)
<B>remove_child_at ($index)B> Remove the child at this position. (zero-base index)
<B>traverse (\&func)B> Takes a reference to a subroutine and traverses the tree applying this subroutine to every descendant.
<B>siblingsB> Returns an array reference of all siblings (not including us)
<B>to_pure_treeB> Invokes reconstruct_with_class with Forest::Tree::Pure.
<B>to_mutable_treeB> Returns the invocant (without cloning).
<B>cloneB> See clone in Forest::Tree::Pure.

This variant will <B>notB> clone the parent, but return a clone of the subtree that is detached.

<B>get_index_in_siblingsB> Returns the index of the tree in the list of children.

Equivalent to calling $tree-parent->get_child_index($tree)>.

Returns -1 if the node has no parent (the root node).

BUGS

All complex software has bugs lurking in it, and this module is no exception. If you find a bug please either email me, or add the bug to cpan-RT.

AUTHOR

Stevan Little <stevan.little@iinteractive.com>

COPYRIGHT AND LICENSE

Copyright 2008-2014 Infinity Interactive, Inc.

<http://www.iinteractive.com>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 FOREST::TREE (3) 2013-12-18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.