fix javadoc generation
[sbp.git] / src / edu / berkeley / sbp / Node.java
index 1d5e05a..6aecefa 100644 (file)
-// Copyright 2006 all rights reserved; see LICENSE file for BSD-style license
+// Copyright 2006-2007 all rights reserved; see LICENSE file for BSD-style license
 
 package edu.berkeley.sbp;
 import edu.berkeley.sbp.*;
 import edu.berkeley.sbp.util.*;
 import edu.berkeley.sbp.Parser.Table.*;
-import edu.berkeley.sbp.Sequence.Position;
+import edu.berkeley.sbp.Sequence.Pos;
+import edu.berkeley.sbp.Sequence.Pos;
 import java.io.*;
 import java.util.*;
 import java.lang.reflect.*;
 
-/** a node in the GSS */
-final class Node
-    implements Invokable<Position, Boolean, Result>,
-               IntegerMappable,
+abstract class Node<OtherNode extends Node>
+    implements IntegerMappable,
                GraphViz.ToGraphViz,
-               Iterable<Result> {
+               Iterable<OtherNode> {
 
-    /** which GSS.Phase this Node belongs to */
-    public  GSS.Phase phase() { return phase; }
-    public Iterator<Result> iterator() { return results.iterator(); }
-    public Parser.Table.State state() { return state; }
+    private final GSS.Phase phase;
+    private final GSS.Phase predecessorPhase;
+    protected boolean destroyed        = false;
+    private int numNonDoomedSuccessors = 0;
+    private boolean hasPathToRoot      = false;
+
+    private       FastSet<OtherNode> predecessors = new FastSet<OtherNode>();
+    private       FastSet<OtherNode> successors = new FastSet<OtherNode>();
+    //protected       HashSet<OtherNode> predecessors = new HashSet<OtherNode>();
+    //protected       HashSet<OtherNode> successors = new HashSet<OtherNode>();
+
+    public GSS.Phase phase() { return phase; }
+    public GSS.Phase predecessorPhase() { return predecessorPhase; }
+    public boolean hasPredecessors() { return predecessors.size() > 0; }
+    public boolean hasSuccessors() { return successors.size() > 0; }
+    public boolean hasNonDoomedSuccessors() { return numNonDoomedSuccessors > 0; }
+
+    public boolean hasPathToRoot() { return hasPathToRoot; }
+    public void updatePathsToRootAfterRemoval() {
+        if (!hasPathToRoot()) return;
+        for(OtherNode on : predecessors)
+            if (on.hasPathToRoot())
+                return;
+        hasPathToRoot = false;
+        for(OtherNode on : successors)
+            on.updatePathsToRootAfterRemoval();
+    }
 
-    public int toInt() { return idx; }
+    /**
+     *  Every Node has a phase; StateNodes belong to the phase in
+     *  which they were shifted, ResultNodes belong to the phase of
+     *  their predecessors.  All of the predecessors of a given node
+     *  must belong to the same phase
+     */
+    public Node(GSS.Phase phase, GSS.Phase predecessorPhase) {
+        this.phase = phase;
+        this.predecessorPhase = predecessorPhase;
+    }
 
-    public boolean merge(Result r) {
-        if (results.contains(r)) return true;
-        results.add(r);
-        r.addChild(this);
-        if (fromEmptyReduction) return false;
-        state.invokeReductions(phase().getToken(), this, false, r);
-        return false;
+    /** only to be invoked (or overridden as public) by the subclass */
+    protected void addPred(OtherNode pred) {
+        if (predecessors.contains(pred)) throw new Error("a predecessor was added twice");
+        if (pred.phase() != predecessorPhase()) throw new Error();
+        predecessors.add(pred);
+        pred.addSucc(this);
+        if (pred.hasPathToRoot()) hasPathToRoot = true;
+    }
+    public void addSucc(OtherNode succ) {
+        if (successors.contains(succ)) throw new Error("a predecessor was added twice");
+        successors.add(succ);
+        numNonDoomedSuccessors += succ.isDoomedState() ? 0 : 1;
+        if (predecessors.size() > 1 && (((Object)this) instanceof ResultNode)) throw new Error();
     }
 
-    private boolean destroyed = false;
-    public boolean check() {
-        boolean dead = true;
-        // - all nodes must have a parent
-        // - non-doomed nodes must either:
-        //      - be on the frontier or
-        //      - have a non-doomed node closer to the frontier than themself
-
-        if (phase.isFrontier()) dead = false;
-        for(Result r : children)
-            if (state.doomed) { if (r.usedByAnyNode()) dead = false; }
-            else              { if (r.usedByNonDoomedNode()) dead = false; }
-        dead |= results.size()==0;
-        if (!dead || destroyed) return dead;
+    protected void destroy() {
         destroyed = true;
-        while(children.size()>0)
-            for(Result r : children) {
-                children.remove(r);
-                r.destroy();
-                break;
-            }
-        while(results.size()>0)
-            for(Result r : results) {
-                results.remove(r);
-                r.removeChild(this);
-                r.check();
-                break;
-            }
-        return dead;
+        while(predecessors.size() > 0) {
+            OtherNode pred = predecessors.first();
+            removePred(pred);
+            pred.removeSucc(this);
+        }
+        predecessors = null;
+        while(successors.size() > 0) {
+            OtherNode succ = successors.first();
+            removeSucc(succ);
+            succ.removePred(this);
+        }
+        successors = null;
     }
-
-    //////////////////////////////////////////////////////////////////////
-
-    private static int node_idx = 0;
-    private final int idx = node_idx++;
-
-    private final GSS.Phase phase;
-    private final Parser.Table.State state;
-    private final boolean fromEmptyReduction;
-    //private       FastSet<Result> results = new FastSet<Result>();
-    private       HashSet<Result> results = new HashSet<Result>();
-    private       HashSet<Result> children = new HashSet<Result>();
-    public void removeChild(Result child) { children.remove(child); }
-    public void removeResult(Result result) { results.remove(result); }
-    public void addChild(Result child) { children.add(child); }
-
-    public final void invoke(Position r, Boolean emptyProductions, Result only) {
-        if (emptyProductions != (r.pos==0)) return;
-        if (r.pos==0) finish(r, r.zero(phase().getLocation().createRegion(phase().getLocation())), phase());
-        else          reduce(r, r.pos-1, phase(), only);
+    public void removeSucc(OtherNode succ) {
+        if (!successors.contains(succ)) return;
+        successors.remove(succ);
+        numNonDoomedSuccessors -= succ.isDoomedState() ? 0 : 1;
+        check();
     }
-
-    private void reduce(Position r, int pos, GSS.Phase target, Result only) {
-        Forest[] holder = r.holder;
-        Forest old = holder[pos];
-        for(Result res : results)
-            if (only == null || res == only) {
-                Node child = res.parent();
-                holder[pos] = res.getForest();
-                if (pos>0)  child.reduce(r, pos-1, target, null);
-                else new Reduction(child, r, r.rewrite(child.phase().getLocation().createRegion(target.getLocation())), target);
-            }
-        holder[pos] = old;
+    public void removePred(OtherNode pred) {
+        if (!predecessors.contains(pred)) return;
+        predecessors.remove(pred);
+        updatePathsToRootAfterRemoval();
+        check();
     }
 
-    void finish(Position r, Forest forest, GSS.Phase target) {
-        Parser.Table.State state0 = (Parser.Table.State)state.gotoSetNonTerminals.get(r.owner());
-        Result result = new Result(forest, this, r);
-        target.newNodeFromReduction(result, state0, r.pos<=0, r);
-    }
 
-    Node(GSS.Phase phase, Result result, State state, boolean fromEmptyReduction) {
-        this.phase = phase;
-        this.state = state;
-        this.fromEmptyReduction = fromEmptyReduction;
-        results.add(result);
-        result.addChild(this);
-        if (phase.hash.get(state, result.phase()) != null) throw new Error("severe problem!");
-        phase.hash.put(state, result.phase(), this);
-
-        for(Object s : state.also)
-            phase.newNode(new Result(null, this, null), (State)s, fromEmptyReduction);
-
-        state.invokeReductions(phase().token, this, true, null);
-        if (!fromEmptyReduction)
-            state.invokeReductions(phase().getToken(), this, false, null);
+    public abstract boolean isDoomedState();
+    protected abstract void check();
+
+    public Iterator<OtherNode> iterator() { return predecessors.iterator(); }
+    public Iterable<OtherNode> successors() { return successors; }
+
+    public boolean noSuccessors() { return successors.size()==0; }
+    public boolean predecessorsContains(OtherNode n) {
+        return predecessors.contains(n);
     }
 
     // GraphViz //////////////////////////////////////////////////////////////////////////////
 
-    public GraphViz.Node toGraphViz(GraphViz gv) {
-        if (results.size()==0) return null;
+    public GraphViz.StateNode toGraphViz(GraphViz gv) {
         if (gv.hasNode(this)) return gv.createNode(this);
-        GraphViz.Node n = gv.createNode(this);
-        n.label = ""+state.toStringx();
+        GraphViz.StateNode n = gv.createNode(this);
+        /*
+        n.label = ""+f;
+        n.shape = "rectangle";
+        //if (pred()!=null) n.edge(pred, "");
+        n.color = "blue";
+        if (phase() != null)
+            ((GraphViz.Group)phase().toGraphViz(gv)).add(n);
+        n.label = "state["+state.toInt()+"]";
         n.shape = "rectangle";
-        boolean hasparents = false;
-        for(Result r : results) n.edge(r, "");
+        boolean haspreds = false;
+        for(ResultNode r : results) n.edge(r, "");
         n.color = state.doomed ? "red" : "green";
         ((GraphViz.Group)phase().toGraphViz(gv)).add(n);
+        */
         return n;
     }
     public boolean isTransparent() { return false; }
     public boolean isHidden() { return false; }
 
-}
+    // IntegerMappable ////////////////////////////////////////////////////////////
+
+    private static int node_idx = 0;
+    private final int idx = node_idx++;
+    public int toInt() { return idx; }
+
+}
\ No newline at end of file