Interface HeapGraph<T extends InstanceKey>

All Superinterfaces:

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

All Known Implementing Classes:

BasicHeapGraph, HeapGraphImpl

public interface HeapGraph<T extends InstanceKey>
extends NumberedGraph<Object>

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.

Method Summary

Modifier and Type	Method	Description
HeapModel	getHeapModel()
PointerAnalysis<T>	getPointerAnalysis()
Collection<Object>	getReachableInstances(Set<Object> roots)

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 Graph

removeNodeAndEdges

Modifier and Type	Method	Description
void	removeNodeAndEdges(Object n)	remove a node and all its incident edges

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, iterateNodes

Modifier and Type	Method	Description
int	getMaxNumber()
Object	getNode(int number)
int	getNumber(Object N)
Iterator<Object>	iterateNodes(IntSet s)

Method Details

getReachableInstances

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

getHeapModel

HeapModel getHeapModel()

getPointerAnalysis

PointerAnalysis<T> getPointerAnalysis()