checkpoint
[sbp.git] / src / edu / berkeley / sbp / Tree.java
index 7dbda47..2bfd187 100644 (file)
@@ -17,16 +17,22 @@ public class Tree<T>
     private final Tree<T>[]    children;
     private final boolean      lift;
 
+    /** the element at the head of the tree */
     public T                 head()        { return head; }
 
     private Tree<T> lifted() { return children[children.length-1]; }
 
+    /** the number of children the tree has */
     public int               numChildren() {
         return lift
             ? (children.length-1)+lifted().numChildren()
             : children.length;
     }
+
+    /** the tree's children */
     public Iterable<Tree<T>> children()    { return this; }
+
+    /** the tree's children */
     public Iterator<Tree<T>> iterator()    {
         return lift
             ? new ConcatenateIterator(new ArrayIterator(children, 0, children.length-1),
@@ -34,24 +40,25 @@ public class Tree<T>
             : new ArrayIterator(children);
     }
 
+    /** get the <tt>i</t>th child */
     public Tree<T> child(int i)  {
         return lift && i >= children.length-1
             ? children[children.length-1].child(i-(children.length-1))
             : children[i];
     }
 
+    /** get the input region that this tree was parsed from */
     public Input.Region    getRegion() { return location; }
 
     public Tree(Input.Region loc, T head)                     { this(loc, head, null); }
     public Tree(Input.Region loc, T head, Tree<T>[] children) { this(loc, head, children, false); }
-    public Tree(Input.Region loc, T head, Tree<T>[] children, boolean lift) {
+
+    /** package-private constructor, allows setting the "lift" bit */
+    Tree(Input.Region loc, T head, Tree<T>[] children, boolean lift) {
         this.location = loc;
         this.head = head;
         this.lift = lift && children != null && children.length > 0;
-
-        Tree<T>[] children2 = children==null ? new Tree[0] : new Tree[children.length];
-        if (children != null) System.arraycopy(children, 0, children2, 0, children.length);
-        this.children = children2;
+        this.children = ArrayUtil.clone(children, Tree.class);
     }
 
 
@@ -79,13 +86,10 @@ public class Tree<T>
         if (gv.hasNode(this)) return gv.createNode(this);
         GraphViz.Node n = gv.createNode(this);
         n.label = head()==null ? "" : head().toString();
-        //n.color = "red";
         for(Tree t : this) n.edge(t, null);
         return n;
     }
     public boolean isTransparent() { return false; }
     public boolean isHidden() { return false; }
 
-    public static interface TreeFunctor<T,R> extends Functor<Iterable<Tree<T>>, R> { }
-    
 }