checkpoint
[sbp.git] / src / edu / berkeley / sbp / Forest.java
index 48f88a2..1c8fbc5 100644 (file)
@@ -6,89 +6,82 @@ import java.io.*;
 import java.util.*;
 import java.lang.reflect.*;
 
-/** an efficient representation of a collection of trees (Tomita's shared packed parse forest) */
-public abstract class Forest<T> /*extends PrintableTree<Forest.MyBody<T>>*/
-    implements Visitable<Forest.Body<T>>,
-               IntegerMappable,
-               GraphViz.ToGraphViz {
-
-    private static int master_idx = 0;
-    private final int idx = master_idx++;
-    public int toInt() { return idx; }
-
-    public abstract void expand(TaskList tl, HashSet<Tree<T>> ht);
-    public abstract void gather(TaskList tl, HashSet<Tree<T>>[] ht, HashSet<Tree<T>> target);
-
-    public static class TaskList extends ArrayList<TaskList.Task> {
-        public interface Task {
-            public void perform();
-        }
-        public class ExpandTask implements Task {
-            private Forest f;
-            private HashSet hs;
-            public ExpandTask(Forest f, HashSet hs) { this.f = f; this.hs = hs; }
-            public void perform() { f.expand(TaskList.this, hs); }
-        }
-        public class GatherTask implements Task {
-            private Forest f;
-            private HashSet[] ht;
-            private HashSet hs;
-            public GatherTask(Forest f, HashSet<Tree<?>>[] ht, HashSet<Tree<?>> hs) { this.f = f; this.hs = hs; this.ht = ht;}
-            public void perform() { f.gather(TaskList.this, ht, hs); }
-        }
-        public void expand(Forest f, HashSet hs) {
-            add(new ExpandTask(f, hs));
-        }
-        public void gather(Forest f, HashSet[] ht, HashSet hs) {
-            add(new GatherTask(f, ht, hs));
-        }
-        public void run() {
-            while(true) {
-                if (isEmpty()) return;
-                Task task = get(size()-1);
-                remove(size()-1);
-                task.perform();
-            }
-        }
-    }
+/**
+ *   An efficient representation of a collection of trees (Tomita's
+ *   shared packed parse forest).
+ */
+public abstract class Forest<T> implements GraphViz.ToGraphViz {
 
     /** assume that this forest contains exactly one tree and return it; otherwise throw an exception */
-    public final Tree<T> expand1() throws Ambiguous, ParseFailed {
-        try {
-            Iterator<Tree<T>> it = expand(true).iterator();
-            if (!it.hasNext()) throw new ParseFailed();
-            return it.next();
-        } catch (InnerAmbiguous ia) { throw new Ambiguous(ia.f); }
-    }
+    public abstract Tree<T> expand1() throws Ambiguous;
 
     /** expand this forest into a set of trees */
-    public HashSet<Tree<T>> expand(boolean toss) {
-        TaskList tl = new TaskList();
-        HashSet<Tree<T>> ret = new HashSet<Tree<T>>();
-        tl.expand(this, ret);
-        tl.run();
-
-        if (toss && ret.size() > 1) throw new InnerAmbiguous(this);
-        return ret;
-    }
+    public void expand(HashSet<Tree<T>> ht) { expand(ht, new HashSet<Forest<T>>(), null); }
 
-    private static class InnerAmbiguous extends RuntimeException {
-        public final Forest<?> f;
-        public InnerAmbiguous(Forest<?> f) { this.f = f; }
+    /** create a new forest */
+    public static <T> Forest<T> create(Input.Region loc, T head, Forest<T>[] children, boolean unwrap) {
+        return new One<T>(loc, head, children, unwrap);
     }
 
-    static        <T> Forest<T> leaf(Input.Region loc, T tag, Position p) { return create(loc, tag, null, false, p); }
-    public static <T> Forest<T> create(Input.Region loc, T tag, Forest<T>[] tokens, boolean unwrap, Position p) {
-        return new MyBody<T>(loc, tag, tokens, unwrap);
-    }
-    // Body //////////////////////////////////////////////////////////////////////////////
+    // Package-Private //////////////////////////////////////////////////////////////////////////////
+
+    abstract void expand(HashSet<Tree<T>> ht, HashSet<Forest<T>> ignore, Tree<T> bogus);
+    abstract void gather(HashSet<Forest<T>> ignore);
+    boolean ambiguous() { return false; }
 
-    public /*protected*/ static interface Body<T> extends GraphViz.ToGraphViz {
-        void expand(int i, TreeBuilder<T> h);
-    }
     public abstract void edges(GraphViz.Node n);
-    public boolean ambiguous() { return false; }
-    public /*protected*/ static class MyBody<T> extends Forest<T> implements Body<T> /* extends PrintableTree<Forest<T>> implements */ {
+
+
+    // One //////////////////////////////////////////////////////////////////////////////
+
+    /** A "single" forest with a head and child subforests */    
+    private static class One<T> extends Forest<T> {
+
+        private final Input.Region      location;
+        private final T                 head;
+        private final Forest<T>[]       children;
+
+        /** if true, the last child's children are considered children of this node */
+        private final boolean           unwrap;
+
+        private One(Input.Region loc, T head, Forest<T>[] children, boolean unwrap) {
+            this.location = loc;
+            this.head = head;
+            this.children = children==null ? emptyForestArray : new Forest[children.length];
+            if (children != null) System.arraycopy(children, 0, this.children, 0, children.length);
+            if (children != null) for(int i=0; i<children.length; i++) if (children[i]==null) throw new Error(i+"");
+            this.unwrap = unwrap;
+        }
+
+        public Tree<T> expand1() throws Ambiguous {
+            Tree<T>[] ret = new Tree[children.length];
+            for(int i=0; i<children.length; i++) ret[i] = children[i].expand1();
+            return new Tree<T>(location, head, ret, unwrap);
+        }
+
+        void gather(HashSet<Forest<T>> hf) {
+            hf.add(this);
+            for(Forest<T> f : children) f.gather(hf);
+        }
+        void expand(HashSet<Tree<T>> ht, HashSet<Forest<T>> ignore, Tree<T> bogus) {
+            if (ignore.contains(this)) { ht.add(bogus); return; }
+            expand(0, new Tree[children.length], ht, ignore, bogus);
+        }
+        private void expand(final int i, Tree<T>[] ta, HashSet<Tree<T>> ht, HashSet<Forest<T>> ignore, Tree<T> bogus) {
+            if (i==children.length) {
+                ht.add(new Tree<T>(location, head, ta, unwrap));
+            } else {
+                HashSet<Tree<T>> ht2 = new HashSet<Tree<T>>();
+                children[i].expand(ht2, ignore, bogus);
+                for(Tree<T> tc : ht2) {
+                    ta[i] = tc;
+                    expand(i+1, ta, ht, ignore, bogus);
+                    ta[i] = null;
+                }
+            }
+        }
+
+        // GraphViz, ToInt //////////////////////////////////////////////////////////////////////////////
 
         public boolean isTransparent() { return false; }
         public boolean isHidden() { return false; }
@@ -97,97 +90,23 @@ public abstract class Forest<T> /*extends PrintableTree<Forest.MyBody<T>>*/
             GraphViz.Node n = gv.createNode(this);
             n.label = headToString()==null?"":headToString();
             n.directed = true;
-            //n.comment = reduction==null?null:reduction+"";
             edges(n);
             return n;
         }
-        boolean edges = false;
+        boolean edges = false; // FIXME ??
         public void edges(GraphViz.Node n) {
             if (edges) return;
             edges = true;
-            for(int i=0; i<tokens.length; i++) {
-                if (i==tokens.length-1 && unwrap && !tokens[i].ambiguous()) {
-                    tokens[i].edges(n);
-                } else {
-                    n.edge(tokens[i], null);
-                }
-            }
-        }
-
-        public <B,C> void visit(Invokable<Forest.Body<T>,B,C> ivbc, B b, C c) {
-            ivbc.invoke(this, b, c);
-        }
-
-        private final Input.Region      location;
-        private final T                 tag;
-        private final Forest<T>[]       tokens;
-        private final boolean           unwrap;
-
-        private MyBody(Input.Region loc, T tag, Forest<T>[] tokens, boolean unwrap) {
-            this.location = loc;
-            this.tag = tag;
-            this.tokens = tokens==null ? emptyForestArray : new Forest[tokens.length];
-            if (tokens != null) System.arraycopy(tokens, 0, this.tokens, 0, tokens.length);
-            if (tokens != null) for(int i=0; i<tokens.length; i++) if (tokens[i]==null) throw new Error(i+"");
-            this.unwrap = unwrap;
-        }
-        public void gather(TaskList tl, HashSet<Tree<T>>[] ht, HashSet<Tree<T>> target) {
-            gather(tl, ht, target, new Tree[ht.length], 0);
-        }
-        private void gather(TaskList tl, HashSet<Tree<T>>[] ht, HashSet<Tree<T>> target, Tree[] trees, int i) {
-            if (i==ht.length) {
-                target.add(new Tree<T>(location, tag, trees));
-                return;
-            }
-            for(Tree<T> tree : ht[i]) {
-                if (unwrap && i==trees.length-1) {
-                    // I think this is wrong
-                    Tree[] trees2 = new Tree[trees.length - 1 + tree.numChildren()];
-                    System.arraycopy(trees, 0, trees2, 0, trees.length-1);
-                    for(int j=0; j<tree.numChildren(); j++)
-                        trees2[trees.length-1+j] = tree.child(j);
-                    target.add(new Tree<T>(location, tag, trees2));
+            for(int i=0; i<children.length; i++) {
+                if (i==children.length-1 && unwrap && !children[i].ambiguous()) {
+                    children[i].edges(n);
                 } else {
-                    trees[i] = tree;
-                    gather(tl, ht, target, trees, i+1);
-                    trees[i] = null;
+                    n.edge(children[i], null);
                 }
             }
         }
-        public void expand(TaskList tl, HashSet<Tree<T>> ht) {
-            HashSet<Tree<T>>[] children = new HashSet[tokens.length];
-            tl.gather(this, children, ht);
-            for(int i=0; i<children.length; i++) {
-                children[i] = new HashSet<Tree<T>>();
-                tl.expand(tokens[i], children[i]);
-            }
-        }
-
-        public void expand(final int i, final TreeBuilder<T> h) {
-            if (i==0) h.start(tag, location);
-
-            if (i==tokens.length) {
-                h.finish(tag, location);
-
-            } else if (unwrap && i==tokens.length-1) {
-                if (tokens[i] != null)
-                    tokens[i].visit(h, null, 0);
-
-            } else {
-                tokens[i].visit(new TreeBuilder<T>(h.toss) {
-                    public void start(T head, Input.Region loc) { }
-                    public void addTree(Tree<T> t) { toks.add(t); }
-                    public void finish(T head, Input.Region loc) {
-                        int old = h.toks.size();
-                        h.addTree(new Tree<T>(loc, head, toks.toArray(tree_hint)));
-                        expand(i+1, h);
-                        while(h.toks.size() > old) h.toks.remove(h.toks.size()-1);
-                    }
-                }, null, null);
-            }
-        }
 
-        protected String  headToString()         { return tag==null?null:tag.toString(); }
+        protected String  headToString()         { return head==null?null:head.toString(); }
         protected String  headToJava()           { return "null"; }
         protected String  left()                 { return "{"; }
         protected String  right()                { return "}"; }
@@ -195,36 +114,78 @@ public abstract class Forest<T> /*extends PrintableTree<Forest.MyBody<T>>*/
     }
 
 
-    // Ref //////////////////////////////////////////////////////////////////////////////
+    // Many //////////////////////////////////////////////////////////////////////////////
 
-    /**
-     *  This class represents a partially complete collection of
-     *  forests to be viewed as a forest at some later date; once
-     *  viewed, it becomes immutable
-     */
-    static class Ref<T> extends Forest<T> {
-        public void expand(TaskList tl, HashSet<Tree<T>> ht) {
-            for (Forest<T> f : hp) f.expand(tl, ht);
-        }
-        public void gather(TaskList tl, HashSet<Tree<T>>[] ht, HashSet<Tree<T>> target) {
-            throw new Error();
+    /** An "ambiguity node"; this is immutable once it has been "looked at" */
+    static class Many<T> extends Forest<T> {
+
+        HashSet<GSS.Phase.Node> parents = new HashSet<GSS.Phase.Node>();
+        private FastSet<Forest<T>> hp = new FastSet<Forest<T>>();
+        private boolean touched = false;
+
+        public Many() { }
+
+        public Tree<T> expand1() throws Ambiguous {
+            touched();
+            if (hp.size() > 1) {
+                HashSet<Forest<T>> hf0 = new HashSet<Forest<T>>();
+                Iterator<Forest<T>> ih = hp.iterator();
+                ih.next().gather(hf0);
+                for(Forest<T> f : hp) {
+                    HashSet<Forest<T>> hf1 = new HashSet<Forest<T>>();
+                    f.gather(hf1);
+                    hf0.retainAll(hf1);
+                }
+                HashSet<Tree<T>> ht = new HashSet<Tree<T>>();
+                expand(ht, hf0, new Tree(null, "*"));
+                throw new Ambiguous((Forest<?>)this,
+                                    (HashSet<Tree<?>>)(Object)ht);
+            }
+            return hp.iterator().next().expand1();
+        }
+        
+        void gather(HashSet<Forest<T>> ht) {
+            touched();
+            ht.add(this);
+            for(Forest<T> f : hp) f.gather(ht);
+        }
+
+        private void touched() {
+            if (touched) return;
+            touched = true;
+            /*
+            FastSet<Forest<T>> f2 = new FastSet<Forest<T>>();
+            for(Forest f : hp)
+                if (f instanceof Forest.One) f2.add(f);
+                else for(Forest ff : ((Forest.Many<T>)f))
+                    f2.add(ff);
+            hp = f2;
+            */
         }
-        public HashSet<GSS.Phase.Node> parents = new HashSet<GSS.Phase.Node>();
         public boolean contains(Forest f) {
+            touched();
             return hp.contains(f);
         }
-        public boolean ambiguous() {
+        public void merge(Forest p) { 
+            if (touched) throw new RuntimeException("attempt to merge() on a Forest.Many that has already been examined");
+            if (p==this) throw new RuntimeException("attempt to merge() a Forest.Many to itself!");
+            hp.add(p, true);
+        }
+        boolean ambiguous() {
+            touched();
             if (hp.size()==0) return false;
             if (hp.size()==1) return hp.iterator().next().ambiguous();
             return true;
         }
-        private FastSet<Forest<T>> hp = new FastSet<Forest<T>>();
-        public Ref() { }
-        public int toInt() {
-            if (hp.size()==1) return hp.iterator().next().toInt();
-            return super.toInt();
+
+        void expand(HashSet<Tree<T>> ht, HashSet<Forest<T>> ignore, Tree<T> bogus) {
+            touched();
+            if (ignore.contains(this)) { ht.add(bogus); return; }
+            for (Forest<T> f : hp) f.expand(ht, ignore, bogus);
         }
-        public void merge(Forest p) { if (p!=this) hp.add(p, true); }
+
+
+        // GraphViz, ToInt //////////////////////////////////////////////////////////////////////////////
 
         public boolean isTransparent() { return hp.size()==1; }
         public boolean isHidden() { return hp.size()==0; }
@@ -233,7 +194,6 @@ public abstract class Forest<T> /*extends PrintableTree<Forest.MyBody<T>>*/
             for(Forest f : hp) f.edges(n);
         }
         public GraphViz.Node toGraphViz(GraphViz gv) {
-            //if (hp.size()==0) return null;
             if (hp.size()==1) return hp.iterator().next().toGraphViz(gv);
             if (gv.hasNode(this)) return gv.createNode(this);
             GraphViz.Node n = gv.createNode(this);
@@ -242,17 +202,8 @@ public abstract class Forest<T> /*extends PrintableTree<Forest.MyBody<T>>*/
             for(Forest f : hp) n.edge(f, null);
             return n;
         }
-
-        public <B,C> void visit(Invokable<Forest.Body<T>,B,C> ivbc, B b, C c) {
-            if (hp==null) return;
-            for(Forest<T> f : hp)
-                f.visit(ivbc, b, c);
-        }
-        public Forest resolve() { return this; }
     }
 
-    public abstract <B,C> void visit(Invokable<Forest.Body<T>,B,C> ivbc, B b, C c);
-
     // Statics //////////////////////////////////////////////////////////////////////////////
 
     private static Tree[] tree_hint = new Tree[0];