Class HeapGraphImpl<T extends InstanceKey>

java.lang.Object

com.ibm.wala.analysis.pointers.HeapGraphImpl<T>

All Implemented Interfaces:

HeapGraph<T>, EdgeManager<Object>, Graph<Object>, NodeManager<Object>, NumberedEdgeManager<Object>, NumberedGraph<Object>, NumberedNodeManager<Object>, Iterable<Object>

Direct Known Subclasses:

BasicHeapGraph

public abstract class HeapGraphImpl<T extends InstanceKey>
extends Object
implements HeapGraph<T>

A Graph view of a pointer analysis solution.

Nodes in the Graph are PointerKeys and InstanceKeys.

There is an edge from a PointerKey P to an InstanceKey I iff the PointerAnalysis indicates that P may point to I.

There is an edge from an InstanceKey I to a PointerKey P iff - P represents a field of an object instance modeled by I, or - P represents the array contents of array instance I.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HeapGraphImpl(PointerAnalysis<T> pa)

Method Summary

Modifier and Type	Method	Description
HeapModel	getHeapModel()
PointerAnalysis<T>	getPointerAnalysis()
Collection<Object>	getReachableInstances(Set<Object> roots)
Iterator<Object>	iterateNodes(IntSet s)
void	removeNodeAndEdges(Object N)	remove a node and all its incident edges

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface EdgeManager

addEdge, getPredNodeCount, getPredNodes, getSuccNodeCount, getSuccNodes, hasEdge, removeAllIncidentEdges, removeEdge, removeIncomingEdges, removeOutgoingEdges

Modifier and Type	Method	Description
void	addEdge(Object src, Object dst)
int	getPredNodeCount(Object n)	Return the number of immediate predecessor nodes of n
Iterator<Object>	getPredNodes(Object n)	Return an Iterator over the immediate predecessor nodes of n
int	getSuccNodeCount(Object N)	Return the number of immediate successor nodes of this Node in the Graph
Iterator<Object>	getSuccNodes(Object n)	Return an Iterator over the immediate successor nodes of n
boolean	hasEdge(Object src, Object dst)
void	removeAllIncidentEdges(Object node)
void	removeEdge(Object src, Object dst)
void	removeIncomingEdges(Object node)
void	removeOutgoingEdges(Object node)

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface NodeManager

addNode, containsNode, getNumberOfNodes, iterator, removeNode, stream

Modifier and Type	Method	Description
void	addNode(Object n)	add a node to this graph
boolean	containsNode(Object n)
int	getNumberOfNodes()
default Iterator<Object>	iterator()
void	removeNode(Object n)	remove a node from this graph
Stream<Object>	stream()

Methods inherited from interface NumberedEdgeManager

getPredNodeNumbers, getSuccNodeNumbers

Modifier and Type	Method	Description
IntSet	getPredNodeNumbers(Object node)
IntSet	getSuccNodeNumbers(Object node)

Methods inherited from interface NumberedNodeManager

getMaxNumber, getNode, getNumber

Modifier and Type	Method	Description
int	getMaxNumber()
Object	getNode(int number)
int	getNumber(Object N)

Constructor Details

HeapGraphImpl

protected HeapGraphImpl(PointerAnalysis<T> pa)

Method Details

iterateNodes

public Iterator<Object> iterateNodes(IntSet s)

Specified by:

iterateNodes in interface NumberedNodeManager<T extends InstanceKey>

Returns:

iterator of nodes with the numbers in set s

getReachableInstances

public Collection<Object> getReachableInstances(Set<Object> roots)

Specified by:

getReachableInstances in interface HeapGraph<T extends InstanceKey>

removeNodeAndEdges

public void removeNodeAndEdges(Object N)
                        throws UnsupportedOperationException

Description copied from interface: Graph

remove a node and all its incident edges

Specified by:

removeNodeAndEdges in interface Graph<T extends InstanceKey>

Throws:

UnsupportedOperationException - if the graph implementation does not allow removal

getHeapModel

public HeapModel getHeapModel()

Specified by:

getHeapModel in interface HeapGraph<T extends InstanceKey>

Returns:

the heap model used in this pointer analysis.

getPointerAnalysis

public PointerAnalysis<T> getPointerAnalysis()

Specified by:

getPointerAnalysis in interface HeapGraph<T extends InstanceKey>