bug fixes + generating PC/RETURNLOC in a flow graph
[IRC.git] / Robust / src / Analysis / SSJava / BuildLattice.java
1 package Analysis.SSJava;
2
3 import java.util.HashMap;
4 import java.util.HashSet;
5 import java.util.Iterator;
6 import java.util.Map;
7 import java.util.Set;
8
9 import IR.Descriptor;
10 import IR.MethodDescriptor;
11 import Util.Pair;
12
13 public class BuildLattice {
14
15   private LocationInference infer;
16
17   private final HNode topNode;
18   private final HNode bottomNode;
19
20   public BuildLattice(LocationInference infer) {
21     this.infer = infer;
22     topNode = new HNode(infer.ssjava.TOP);
23     bottomNode = new HNode(infer.ssjava.BOTTOM);
24   }
25
26   public SSJavaLattice<String> buildLattice(Descriptor desc) {
27
28     HierarchyGraph inputGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
29     LocationSummary locSummary = infer.getLocationSummary(desc);
30
31     Set<HNode> nodeSetWithCompositeLocation = new HashSet<HNode>();
32     if (desc instanceof MethodDescriptor) {
33       FlowGraph flowGraph = infer.getFlowGraph((MethodDescriptor) desc);
34
35       for (Iterator iterator = inputGraph.getNodeSet().iterator(); iterator.hasNext();) {
36         HNode hnode = (HNode) iterator.next();
37         Descriptor hnodeDesc = hnode.getDescriptor();
38         if (hnodeDesc != null) {
39           NTuple<Descriptor> descTuple = new NTuple<Descriptor>();
40           descTuple.add(hnodeDesc);
41
42           if (flowGraph.contains(descTuple)) {
43             FlowNode flowNode = flowGraph.getFlowNode(descTuple);
44             if (flowNode.getCompositeLocation() != null) {
45               nodeSetWithCompositeLocation.add(hnode);
46             }
47           }
48
49         }
50       }
51
52     }
53
54     BasisSet basisSet = inputGraph.computeBasisSet(nodeSetWithCompositeLocation);
55     debug_print(inputGraph);
56
57     Family family = generateFamily(basisSet);
58     Map<Set<Integer>, Set<Set<Integer>>> mapImSucc = coveringGraph(basisSet, family);
59
60     SSJavaLattice<String> lattice = buildLattice(basisSet, inputGraph, locSummary, mapImSucc);
61     return lattice;
62
63   }
64
65   private SSJavaLattice<String> buildLattice(BasisSet basisSet, HierarchyGraph inputGraph,
66       LocationSummary locSummary, Map<Set<Integer>, Set<Set<Integer>>> mapImSucc) {
67
68     SSJavaLattice<String> lattice =
69         new SSJavaLattice<String>(SSJavaAnalysis.TOP, SSJavaAnalysis.BOTTOM);
70
71     Map<Set<Integer>, String> mapFToLocName = new HashMap<Set<Integer>, String>();
72
73     Set<Set<Integer>> keySet = mapImSucc.keySet();
74     for (Iterator iterator = keySet.iterator(); iterator.hasNext();) {
75       Set<Integer> higher = (Set<Integer>) iterator.next();
76
77       String higherName = generateElementName(basisSet, inputGraph, mapFToLocName, higher);
78
79       HNode higherNode = inputGraph.getHNode(higherName);
80       if (higherNode != null && higherNode.isSharedNode()) {
81         lattice.addSharedLoc(higherName);
82       }
83       Set<Descriptor> descSet = inputGraph.getDescSetOfNode(higherNode);
84       // System.out.println("higherName=" + higherName + "  higherNode=" + higherNode + "  descSet="
85       // + descSet);
86       for (Iterator iterator2 = descSet.iterator(); iterator2.hasNext();) {
87         Descriptor d = (Descriptor) iterator2.next();
88         locSummary.addMapHNodeNameToLocationName(d.getSymbol(), higherName);
89       }
90       // locSummary.addMapHNodeNameToLocationName(higherName, higherName);
91
92       Set<Set<Integer>> lowerSet = mapImSucc.get(higher);
93       for (Iterator iterator2 = lowerSet.iterator(); iterator2.hasNext();) {
94         Set<Integer> lower = (Set<Integer>) iterator2.next();
95
96         String lowerName = generateElementName(basisSet, inputGraph, mapFToLocName, lower);
97         HNode lowerNode = inputGraph.getHNode(lowerName);
98         if (lowerNode != null && lowerNode.isSharedNode()) {
99           lattice.addSharedLoc(lowerName);
100         }
101
102         Set<Descriptor> lowerDescSet = inputGraph.getDescSetOfNode(lowerNode);
103         // System.out.println("lowerName=" + lowerName + "  lowerNode=" + lowerNode + "  descSet="
104         // + lowerDescSet);
105         for (Iterator iterator3 = lowerDescSet.iterator(); iterator3.hasNext();) {
106           Descriptor d = (Descriptor) iterator3.next();
107           locSummary.addMapHNodeNameToLocationName(d.getSymbol(), lowerName);
108         }
109         // locSummary.addMapHNodeNameToLocationName(lowerName, lowerName);
110
111         if (higher.size() == 0) {
112           // empty case
113           lattice.put(lowerName);
114         } else {
115           lattice.addRelationHigherToLower(higherName, lowerName);
116         }
117
118       }
119
120     }
121
122     return lattice;
123   }
124
125   public HNode getCombinationNodeInSCGraph(Descriptor desc, HNode nodeFromSimpleGraph) {
126
127     HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
128
129     if (nodeFromSimpleGraph.isSkeleton()) {
130       return scGraph.getCurrentHNode(nodeFromSimpleGraph);
131     }
132
133     Set<HNode> combineSkeletonNodeSet =
134         infer.getSimpleHierarchyGraph(desc).getCombineSetByCombinationNode(nodeFromSimpleGraph);
135     HNode combinationNodeInSCGraph =
136         infer.getSkeletonCombinationHierarchyGraph(desc).getMapCombineNodeSetToCombinationNode()
137             .get(combineSkeletonNodeSet);
138
139     // Set<HNode> combineSkeletonNodeSet =
140     // infer.getSimpleHierarchyGraph(desc).getCombineSetByCombinationNode(simpleGraphNode);
141     // HNode combinationNodeInSCGraph =
142     // infer.getSkeletonCombinationHierarchyGraph(desc).getCombinationNode(combineSkeletonNodeSet);
143     return combinationNodeInSCGraph;
144   }
145
146   public SSJavaLattice<String> insertIntermediateNodesToStraightLine(Descriptor desc,
147       SSJavaLattice<String> skeletonLattice) {
148
149     // perform DFS that starts from each skeleton/combination node and ends by another
150     // skeleton/combination node
151
152     HierarchyGraph simpleGraph = infer.getSimpleHierarchyGraph(desc);
153     HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
154     LocationSummary locSummary = infer.getLocationSummary(desc);
155
156     SSJavaLattice<String> lattice = skeletonLattice.clone();
157
158     Set<HNode> visited = new HashSet<HNode>();
159
160     Set<HNode> nodeSet = simpleGraph.getNodeSet();
161
162     Map<TripleItem, String> mapIntermediateLoc = new HashMap<TripleItem, String>();
163
164     System.out.println("*insert=" + desc);
165     System.out.println("***nodeSet=" + nodeSet);
166     for (Iterator iterator = nodeSet.iterator(); iterator.hasNext();) {
167       HNode node = (HNode) iterator.next();
168       System.out.println("node=" + node);
169       if (node.isSkeleton() && (!visited.contains(node))) {
170         visited.add(node);
171
172         Set<HNode> outSet = simpleGraph.getOutgoingNodeSet(node);
173         for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
174           HNode outNode = (HNode) iterator2.next();
175
176           if (!outNode.isSkeleton()) {
177             if (outNode.isCombinationNode()) {
178               expandCombinationNode(desc, lattice, visited, mapIntermediateLoc, locSummary, outNode);
179             } else {
180               // we have a node that is neither combination or skeleton node
181               // System.out.println("%%%skeleton node=" + node + "  outNode=" + outNode);
182               HNode startNode = scGraph.getCurrentHNode(node);
183
184               // if (node.getDescriptor() != null) {
185               // // node is a skeleton node and it might be merged into another node in the SC
186               // graph.
187               // startNode = scGraph.getHNode(node.getDescriptor());
188               // } else {
189               // // this node has already been merged before the SC graph.
190               // startNode = node;
191               // }
192
193               Set<HNode> endNodeSetFromSimpleGraph =
194                   simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(outNode, null);
195
196               // System.out.println("endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph
197               // + "   from=" + outNode);
198               Set<HNode> endCombNodeSet = new HashSet<HNode>();
199               for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
200                 HNode endNode = (HNode) iterator3.next();
201                 endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
202               }
203               // System.out.println("endCombNodeSet=" + endCombNodeSet);
204               visited.add(outNode);
205               if (endCombNodeSet.size() > 0) {
206                 // follows the straight line up to another skeleton/combination node
207                 endCombNodeSet = removeTransitivelyReachToNode(desc, startNode, endCombNodeSet);
208               } else if (endCombNodeSet.size() == 0) {
209                 // the outNode is (directly/transitively) connected to the bottom node
210                 // therefore, we just add a dummy bottom HNode to the endCombNodeSet.
211                 endCombNodeSet.add(bottomNode);
212               }
213
214
215               recurDFSNormalNode(desc, lattice, startNode, endCombNodeSet, visited,
216                   mapIntermediateLoc, 1, locSummary, outNode);
217             }
218
219           }
220
221         }
222       } else if (!node.isSkeleton() && !node.isCombinationNode() && !node.isMergeNode()
223           && !visited.contains(node)) {
224
225         System.out.println("n=" + node);
226
227         // an intermediate node 'node' may be located between "TOP" location and a skeleton node
228         int sizeIncomingNode = simpleGraph.getIncomingNodeSet(node).size();
229
230         if (sizeIncomingNode == 0) {
231           // this node will be directly connected to the TOP location
232           // start adding the following nodes from this node
233
234           Set<HNode> endNodeSetFromSimpleGraph =
235               simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(node, null);
236
237           Set<HNode> endCombNodeSet = new HashSet<HNode>();
238           for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
239             HNode endNode = (HNode) iterator3.next();
240             endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
241           }
242
243           HNode startNode = topNode;
244           visited.add(startNode);
245           if (endCombNodeSet.size() > 0) {
246             // follows the straight line up to another skeleton/combination node
247             // endCombNodeSet = removeTransitivelyReachToNode(desc, node, endCombNodeSet);
248             recurDFSNormalNode(desc, lattice, startNode, endCombNodeSet, visited,
249                 mapIntermediateLoc, 1, locSummary, node);
250           }
251
252         }
253
254       }
255     }
256
257     return lattice;
258
259   }
260
261   private void expandCombinationNode(Descriptor desc, SSJavaLattice<String> lattice,
262       Set<HNode> visited, Map<TripleItem, String> mapIntermediateLoc, LocationSummary locSummary,
263       HNode cnode) {
264
265     // expand the combination node 'outNode'
266     // here we need to expand the corresponding combination location in the lattice
267     HNode combinationNodeInSCGraph = getCombinationNodeInSCGraph(desc, cnode);
268
269     HierarchyGraph simpleGraph = infer.getSimpleHierarchyGraph(desc);
270
271     Set<HNode> combineSkeletonNodeSet = simpleGraph.getCombineSetByCombinationNode(cnode);
272
273     // System.out.println("combineSkeletonNodeSet=" + combineSkeletonNodeSet);
274
275     Set<HNode> combinationNodeSet =
276         simpleGraph.getCombinationNodeSetByCombineNodeSet(combineSkeletonNodeSet);
277
278     // System.out.println("combinationNodeSet=" + combinationNodeSet);
279
280     Set<HNode> endNodeSetFromSimpleGraph =
281         simpleGraph.getDirectlyReachableSkeletonCombinationNodeFrom(cnode, combinationNodeSet);
282     // System.out.println("-endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph);
283     Set<HNode> endCombNodeSet = new HashSet<HNode>();
284     for (Iterator iterator3 = endNodeSetFromSimpleGraph.iterator(); iterator3.hasNext();) {
285       HNode endNode = (HNode) iterator3.next();
286       endCombNodeSet.add(getCombinationNodeInSCGraph(desc, endNode));
287     }
288     visited.add(cnode);
289
290     // follows the straight line up to another skeleton/combination node
291     if (endCombNodeSet.size() > 0) {
292       System.out.println("---endCombNodeSet=" + endCombNodeSet);
293       endCombNodeSet =
294           removeTransitivelyReachToNode(desc, combinationNodeInSCGraph, endCombNodeSet);
295
296
297       recurDFS(desc, lattice, combinationNodeInSCGraph, endCombNodeSet, visited,
298           mapIntermediateLoc, 1, locSummary, cnode);
299     } else {
300       endCombNodeSet.add(bottomNode);
301       System.out.println("---endCombNodeSet is zero");
302       System.out.println("---endNodeSetFromSimpleGraph=" + endNodeSetFromSimpleGraph);
303       System.out.println("---incoming=" + simpleGraph.getIncomingNodeSet(cnode));
304       recurDFS(desc, lattice, combinationNodeInSCGraph, endCombNodeSet, visited,
305           mapIntermediateLoc, 1, locSummary, cnode);
306
307     }
308
309   }
310
311   private Set<HNode> removeTransitivelyReachToNode(Descriptor desc, HNode startNode,
312       Set<HNode> endNodeSet) {
313
314     // if an end node is not directly connected to the start node in the SC graph
315     // replace it with a directly connected one which transitively reaches to it.
316
317     HierarchyGraph scGraph = infer.getSkeletonCombinationHierarchyGraph(desc);
318
319     Set<HNode> newEndNodeSet = new HashSet<HNode>();
320     for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
321       HNode endNode = (HNode) iterator.next();
322       if (scGraph.isDirectlyConnectedTo(startNode, endNode)) {
323         newEndNodeSet.add(endNode);
324       } else {
325         HNode newEndNode =
326             getDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, endNode);
327         // System.out.println("#### old END NODE=" + endNode + " --->" + newEndNode);
328         newEndNodeSet.add(newEndNode);
329       }
330     }
331
332     // System.out.println("removeTransitivelyReachToNode=" + endNodeSet + "  newSet=" +
333     // newEndNodeSet);
334
335     return newEndNodeSet;
336
337   }
338
339   private HNode getDirectlyReachableSCNodeFromEndNode(HierarchyGraph scGraph, HNode startNode,
340       Set<HNode> endNodeSet) {
341
342     System.out.println("getDirectlyReachableSCNodeFromEndNode start=" + startNode + " endNodeSet="
343         + endNodeSet);
344     Set<HNode> newStartNodeSet = new HashSet<HNode>();
345
346     for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
347       HNode endNode = (HNode) iterator.next();
348       Set<HNode> connectedToEndNodeSet = scGraph.getIncomingNodeSet(endNode);
349
350       for (Iterator iterator2 = connectedToEndNodeSet.iterator(); iterator2.hasNext();) {
351         HNode curNode = (HNode) iterator2.next();
352         if (recurConnectedFromStartNode(scGraph, startNode, curNode, new HashSet<HNode>())) {
353           newStartNodeSet.add(curNode);
354         }
355       }
356     }
357
358     System.out.println("newStartNodeSet=" + newStartNodeSet);
359
360     if (newStartNodeSet.size() == 0) {
361       newStartNodeSet.add(startNode);
362     }
363
364     return newStartNodeSet.iterator().next();
365   }
366
367   private boolean recurConnectedFromStartNode(HierarchyGraph scGraph, HNode startNode,
368       HNode curNode, Set<HNode> visited) {
369     // return true if curNode is transitively connected from the startNode
370
371     boolean isConnected = false;
372     Set<HNode> inNodeSet = scGraph.getIncomingNodeSet(curNode);
373     for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) {
374       HNode in = (HNode) iterator.next();
375       if (in.equals(startNode)) {
376         return true;
377       } else {
378         visited.add(in);
379         isConnected |= recurConnectedFromStartNode(scGraph, startNode, in, visited);
380       }
381     }
382
383     return isConnected;
384   }
385
386   private HNode getDirectlyReachableNodeFromStartNodeReachToEndNode(HierarchyGraph scGraph,
387       HNode startNode, HNode endNode) {
388     System.out.println("getDirectlyReachableNodeFromStartNodeReachToEndNode start=" + startNode
389         + " end=" + endNode);
390     Set<HNode> connected = new HashSet<HNode>();
391     recurDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, endNode, connected);
392     if (connected.size() == 0) {
393       connected.add(endNode);
394     }
395     System.out.println("connected=" + connected);
396
397     return connected.iterator().next();
398   }
399
400   private void recurDirectlyReachableNodeFromStartNodeReachToEndNode(HierarchyGraph scGraph,
401       HNode startNode, HNode curNode, Set<HNode> connected) {
402
403     Set<HNode> inNodeSet = scGraph.getIncomingNodeSet(curNode);
404     for (Iterator iterator = inNodeSet.iterator(); iterator.hasNext();) {
405       HNode inNode = (HNode) iterator.next();
406       if (inNode.equals(startNode)) {
407         connected.add(curNode);
408       } else {
409         recurDirectlyReachableNodeFromStartNodeReachToEndNode(scGraph, startNode, inNode, connected);
410       }
411     }
412
413   }
414
415   private void recurDFSNormalNode(Descriptor desc, SSJavaLattice<String> lattice, HNode startNode,
416       Set<HNode> endNodeSet, Set<HNode> visited, Map<TripleItem, String> mapIntermediateLoc,
417       int idx, LocationSummary locSummary, HNode curNode) {
418
419     TripleItem item = new TripleItem(startNode, endNodeSet, idx);
420     // System.out.println("item=" + item);
421     if (!mapIntermediateLoc.containsKey(item)) {
422       // need to create a new intermediate location in the lattice
423       String newLocName = "ILOC" + (LocationInference.locSeed++);
424       String above;
425       if (idx == 1) {
426         above = startNode.getName();
427       } else {
428         int prevIdx = idx - 1;
429         TripleItem prevItem = new TripleItem(startNode, endNodeSet, prevIdx);
430         above = mapIntermediateLoc.get(prevItem);
431       }
432
433       Set<String> belowSet = new HashSet<String>();
434       for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
435         HNode endNode = (HNode) iterator.next();
436         belowSet.add(endNode.getName());
437       }
438
439       lattice.insertNewLocationBetween(above, belowSet, newLocName);
440
441       mapIntermediateLoc.put(item, newLocName);
442     }
443
444     String locName = mapIntermediateLoc.get(item);
445
446     HierarchyGraph graph = infer.getSimpleHierarchyGraph(desc);
447
448     Set<Descriptor> descSet = graph.getDescSetOfNode(curNode);
449     for (Iterator iterator = descSet.iterator(); iterator.hasNext();) {
450       Descriptor d = (Descriptor) iterator.next();
451       locSummary.addMapHNodeNameToLocationName(d.getSymbol(), locName);
452     }
453     locSummary.addMapHNodeNameToLocationName(curNode.getName(), locName);
454
455     if (curNode.isSharedNode()) {
456       lattice.addSharedLoc(locName);
457     }
458
459     System.out.println("-TripleItem=" + item);
460     System.out.println("-curNode=" + curNode.getName() + " locName=" + locName);
461
462     Set<HNode> outSet = graph.getOutgoingNodeSet(curNode);
463     for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
464       HNode outNode = (HNode) iterator2.next();
465       if (!outNode.isSkeleton() && !outNode.isCombinationNode() && !visited.contains(outNode)) {
466         visited.add(outNode);
467         recurDFSNormalNode(desc, lattice, startNode, endNodeSet, visited, mapIntermediateLoc,
468             idx + 1, locSummary, outNode);
469       } else if (!outNode.isSkeleton() && outNode.isCombinationNode() && !visited.contains(outNode)) {
470         expandCombinationNode(desc, lattice, visited, mapIntermediateLoc, locSummary, outNode);
471       }
472     }
473
474   }
475
476   private void recurDFS(Descriptor desc, SSJavaLattice<String> lattice,
477       HNode combinationNodeInSCGraph, Set<HNode> endNodeSet, Set<HNode> visited,
478       Map<TripleItem, String> mapIntermediateLoc, int idx, LocationSummary locSummary, HNode curNode) {
479
480     TripleItem item = new TripleItem(combinationNodeInSCGraph, endNodeSet, idx);
481
482     if (!mapIntermediateLoc.containsKey(item)) {
483       // need to create a new intermediate location in the lattice
484       String above;
485       if (idx == 1) {
486         String newLocName = combinationNodeInSCGraph.getName();
487         mapIntermediateLoc.put(item, newLocName);
488       } else {
489         String newLocName = "ILOC" + (LocationInference.locSeed++);
490         int prevIdx = idx - 1;
491         TripleItem prevItem = new TripleItem(combinationNodeInSCGraph, endNodeSet, prevIdx);
492         above = mapIntermediateLoc.get(prevItem);
493
494         Set<String> belowSet = new HashSet<String>();
495         for (Iterator iterator = endNodeSet.iterator(); iterator.hasNext();) {
496           HNode endNode = (HNode) iterator.next();
497           belowSet.add(endNode.getName());
498         }
499         lattice.insertNewLocationBetween(above, belowSet, newLocName);
500         mapIntermediateLoc.put(item, newLocName);
501
502       }
503
504     }
505
506     HierarchyGraph graph = infer.getSimpleHierarchyGraph(desc);
507     String locName = mapIntermediateLoc.get(item);
508     Set<Descriptor> descSet = graph.getDescSetOfNode(curNode);
509     for (Iterator iterator = descSet.iterator(); iterator.hasNext();) {
510       Descriptor d = (Descriptor) iterator.next();
511       locSummary.addMapHNodeNameToLocationName(d.getSymbol(), locName);
512     }
513     locSummary.addMapHNodeNameToLocationName(curNode.getName(), locName);
514
515     // System.out.println("-TripleItem=" + item);
516     // System.out.println("-curNode=" + curNode.getName() + " locName=" + locName);
517
518     Set<HNode> outSet = graph.getOutgoingNodeSet(curNode);
519     for (Iterator iterator2 = outSet.iterator(); iterator2.hasNext();) {
520       HNode outNode = (HNode) iterator2.next();
521       if (!outNode.isSkeleton() && !visited.contains(outNode)) {
522         if (combinationNodeInSCGraph.equals(getCombinationNodeInSCGraph(desc, outNode))) {
523           visited.add(outNode);
524           recurDFS(desc, lattice, combinationNodeInSCGraph, endNodeSet, visited,
525               mapIntermediateLoc, idx + 1, locSummary, outNode);
526         }
527       }
528     }
529
530   }
531
532   private String generateElementName(BasisSet basisSet, HierarchyGraph inputGraph,
533       Map<Set<Integer>, String> mapF2LocName, Set<Integer> F) {
534
535     if (mapF2LocName.containsKey(F)) {
536       return mapF2LocName.get(F);
537     }
538
539     HNode node = basisSet.getHNode(F);
540     if (node != null) {
541       mapF2LocName.put(F, node.getName());
542       return node.getName();
543     } else {
544       if (inputGraph.BASISTOPELEMENT.equals(F)) {
545         return SSJavaAnalysis.BOTTOM;
546       } else {
547         String str = "LOC" + (LocationInference.locSeed++);
548         mapF2LocName.put(F, str);
549         return str;
550       }
551     }
552   }
553
554   private void resetCount(Map<Set<Integer>, Integer> mapFtoCount, Family family) {
555     for (Iterator<Set<Integer>> iter = family.FIterator(); iter.hasNext();) {
556       Set<Integer> F = iter.next();
557       mapFtoCount.put(F, 0);
558     }
559   }
560
561   private Map<Set<Integer>, Set<Set<Integer>>> coveringGraph(BasisSet basisSet, Family family) {
562
563     Map<Set<Integer>, Integer> mapFtoCount = new HashMap<Set<Integer>, Integer>();
564     Map<Set<Integer>, Set<Set<Integer>>> mapImSucc = new HashMap<Set<Integer>, Set<Set<Integer>>>();
565
566     // initialize COUNT(F) to 0 for all elements of the family
567     resetCount(mapFtoCount, family);
568
569     for (Iterator<Set<Integer>> iter = family.FIterator(); iter.hasNext();) {
570       Set<Integer> F = iter.next();
571       Set<HNode> gammaF = family.getGamma(F);
572
573       Set<HNode> curHNodeSet = basisSet.getHNodeSet();
574       curHNodeSet.removeAll(gammaF);
575       Set<Set<Integer>> Bset = basisSet.getBasisSetByHNodeSet(curHNodeSet);
576
577       for (Iterator iterator = Bset.iterator(); iterator.hasNext();) {
578         Set<Integer> B = (Set<Integer>) iterator.next();
579
580         Set<Integer> Fprime = new HashSet<Integer>();
581         Fprime.addAll(F);
582         Fprime.addAll(B);
583
584         // COUNT(F')++;
585         mapFtoCount.put(Fprime, mapFtoCount.get(Fprime) + 1);
586
587         // if |gamma(F')|==COUNT(F') + |gamma(F)|
588         int numGammaFprime = family.getGamma(Fprime).size();
589         int countFprime = mapFtoCount.get(Fprime);
590         int numGammaF = family.getGamma(F).size();
591         if (numGammaFprime == (countFprime + numGammaF)) {
592           // ImSucc(F)=IMSucc(F) union F'
593           addImSucc(mapImSucc, F, Fprime);
594         }
595
596       }
597       resetCount(mapFtoCount, family);
598     }
599
600     // System.out.println("mapImSucc=" + mapImSucc);
601
602     return mapImSucc;
603   }
604
605   private Set<Set<Integer>> getImSucc(Map<Set<Integer>, Set<Set<Integer>>> mapImSucc, Set<Integer> F) {
606     if (!mapImSucc.containsKey(F)) {
607       mapImSucc.put(F, new HashSet<Set<Integer>>());
608     }
609     return mapImSucc.get(F);
610   }
611
612   private void addImSucc(Map<Set<Integer>, Set<Set<Integer>>> mapImSucc, Set<Integer> F,
613       Set<Integer> Fprime) {
614
615     if (!mapImSucc.containsKey(F)) {
616       mapImSucc.put(F, new HashSet<Set<Integer>>());
617     }
618
619     mapImSucc.get(F).add(Fprime);
620
621   }
622
623   private Family generateFamily(BasisSet basisSet) {
624
625     Family family = new Family();
626
627     for (Iterator<Set<Integer>> iterator = basisSet.basisIterator(); iterator.hasNext();) {
628       Set<Integer> B = iterator.next();
629
630       Set<Pair<Set<Integer>, Set<HNode>>> tobeadded = new HashSet<Pair<Set<Integer>, Set<HNode>>>();
631
632       for (Iterator<Set<Integer>> iterator2 = family.FIterator(); iterator2.hasNext();) {
633         Set<Integer> F = iterator2.next();
634
635         Set<Integer> Fprime = new HashSet<Integer>();
636         Fprime.addAll(F);
637         Fprime.addAll(B);
638
639         Set<HNode> gammaFPrimeSet = new HashSet<HNode>();
640         gammaFPrimeSet.addAll(family.getGamma(F));
641         gammaFPrimeSet.add(basisSet.getHNode(B));
642
643         if (!family.containsF(Fprime)) {
644           Pair<Set<Integer>, Set<HNode>> pair =
645               new Pair<Set<Integer>, Set<HNode>>(Fprime, gammaFPrimeSet);
646           tobeadded.add(pair);
647         } else {
648           family.updateGammaF(Fprime, gammaFPrimeSet);
649         }
650       }
651
652       for (Iterator<Pair<Set<Integer>, Set<HNode>>> iterator2 = tobeadded.iterator(); iterator2
653           .hasNext();) {
654         Pair<Set<Integer>, Set<HNode>> pair = iterator2.next();
655         family.addFElement(pair.getFirst());
656         family.updateGammaF(pair.getFirst(), pair.getSecond());
657       }
658
659     }
660     return family;
661   }
662
663   private void debug_print(HierarchyGraph inputGraph) {
664     System.out.println("\nBuild Lattice:" + inputGraph.getName());
665     // System.out.println("Node2Index:\n" + inputGraph.getMapHNodeToUniqueIndex());
666     // System.out.println("Node2Basis:\n" + inputGraph.getMapHNodeToBasis());
667   }
668
669 }
670
671 class Identifier {
672   public HNode node;
673   public int idx;
674
675   public Identifier(HNode n, int i) {
676     node = n;
677     idx = i;
678   }
679
680   public int hashCode() {
681     return node.hashCode() + idx;
682   }
683
684   public boolean equals(Object obj) {
685
686     if (obj instanceof Identifier) {
687       Identifier in = (Identifier) obj;
688       if (node.equals(in.node) && idx == in.idx) {
689         return true;
690       }
691     }
692
693     return false;
694   }
695
696 }
697
698 class TripleItem {
699   public HNode higherNode;
700   public Set<HNode> lowerNodeSet;
701   public int idx;
702
703   public TripleItem(HNode h, Set<HNode> l, int i) {
704     higherNode = h;
705     lowerNodeSet = l;
706     idx = i;
707   }
708
709   public int hashCode() {
710
711     int h = 0;
712     if (higherNode != null) {
713       h = higherNode.hashCode();
714     }
715
716     return h + lowerNodeSet.hashCode() + idx;
717   }
718
719   public boolean equals(Object obj) {
720
721     if (obj instanceof TripleItem) {
722       TripleItem in = (TripleItem) obj;
723       if ((higherNode == null || (higherNode != null && higherNode.equals(in.higherNode)))
724           && lowerNodeSet.equals(in.lowerNodeSet) && idx == in.idx) {
725         return true;
726       }
727     }
728
729     return false;
730   }
731
732   public String toString() {
733     return higherNode + "-" + idx + "->" + lowerNodeSet;
734   }
735 }