Package soot.toolkits.graph

Class HashMutableDirectedGraph<N>

java.lang.Object

soot.toolkits.graph.HashMutableDirectedGraph<N>

Type Parameters:

N -

All Implemented Interfaces:

Iterable<N>, DirectedGraph<N>, MutableDirectedGraph<N>

Direct Known Subclasses:

ExtendedHashMutableDirectedGraph, HashReversibleGraph, MemoryEfficientGraph

public class HashMutableDirectedGraph<N>
extends Object
implements MutableDirectedGraph<N>

HashMap based implementation of a MutableBlockGraph.

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<N>	heads
protected Map<N,Set<N>>	nodeToPreds
protected Map<N,Set<N>>	nodeToSuccs
protected Set<N>	tails

Constructor Summary

Constructors

Constructor	Description
HashMutableDirectedGraph()
HashMutableDirectedGraph(HashMutableDirectedGraph<N> orig)

Method Summary

Modifier and Type	Method	Description
void	addEdge(N from, N to)	Adds an edge to the graph between 2 nodes.
void	addNode(N node)	Adds a node to the graph.
void	clearAll()	Removes all nodes and edges.
Object	clone()
boolean	containsEdge(N from, N to)
boolean	containsNode(N node)
List<N>	getHeads()	Returns a list of entry points for this graph.
List<N>	getNodes()
List<N>	getPredsOf(N s)	Returns a list of predecessors for the given node in the graph.
Set<N>	getPredsOfAsSet(N s)	Same as getPredsOf(Object) but returns a set.
List<N>	getSuccsOf(N s)	Returns a list of successors for the given node in the graph.
Set<N>	getSuccsOfAsSet(N s)	Same as getSuccsOf(Object) but returns a set.
List<N>	getTails()	Returns a list of exit points for this graph.
Iterator<N>	iterator()	Returns an iterator for the nodes in this graph.
void	printGraph()
void	removeEdge(N from, N to)	Removes an edge between 2 nodes in the graph.
void	removeNode(N node)	Removes a node from the graph.
int	size()	Returns the node count for this graph.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

nodeToPreds

protected final Map<N,Set<N>> nodeToPreds

nodeToSuccs

protected final Map<N,Set<N>> nodeToSuccs

heads

protected final Set<N> heads

tails

protected final Set<N> tails

Constructor Detail

HashMutableDirectedGraph

public HashMutableDirectedGraph()

HashMutableDirectedGraph

public HashMutableDirectedGraph(HashMutableDirectedGraph<N> orig)

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

clearAll

public void clearAll()

Removes all nodes and edges.

getHeads

public List<N> getHeads()

Description copied from interface: DirectedGraph

Returns a list of entry points for this graph.

Specified by:

getHeads in interface DirectedGraph<N>

getTails

public List<N> getTails()

Description copied from interface: DirectedGraph

Returns a list of exit points for this graph.

Specified by:

getTails in interface DirectedGraph<N>

getPredsOf

public List<N> getPredsOf(N s)

Description copied from interface: DirectedGraph

Returns a list of predecessors for the given node in the graph.

Specified by:

getPredsOf in interface DirectedGraph<N>

getPredsOfAsSet

public Set<N> getPredsOfAsSet(N s)

Same as getPredsOf(Object) but returns a set. This is faster than calling getPredsOf(Object). Also, certain operations like Collection.contains(Object) execute faster on the set than on the list. The returned set is unmodifiable.

getSuccsOf

public List<N> getSuccsOf(N s)

Description copied from interface: DirectedGraph

Returns a list of successors for the given node in the graph.

Specified by:

getSuccsOf in interface DirectedGraph<N>

getSuccsOfAsSet

public Set<N> getSuccsOfAsSet(N s)

Same as getSuccsOf(Object) but returns a set. This is faster than calling getSuccsOf(Object). Also, certain operations like Collection.contains(Object) execute faster on the set than on the list. The returned set is unmodifiable.

size

public int size()

Description copied from interface: DirectedGraph

Returns the node count for this graph.

Specified by:

size in interface DirectedGraph<N>

iterator

public Iterator<N> iterator()

Description copied from interface: DirectedGraph

Returns an iterator for the nodes in this graph. No specific ordering of the nodes is guaranteed.

Specified by:

iterator in interface DirectedGraph<N>

Specified by:

iterator in interface Iterable<N>

addEdge

public void addEdge(N from,
                    N to)

Description copied from interface: MutableDirectedGraph

Adds an edge to the graph between 2 nodes. If the edge is already present no change is made.

Specified by:

addEdge in interface MutableDirectedGraph<N>

Parameters:

from - out node for the edge.

to - in node for the edge.

removeEdge

public void removeEdge(N from,
                       N to)

Description copied from interface: MutableDirectedGraph

Removes an edge between 2 nodes in the graph. If the edge is not present no change is made.

Specified by:

removeEdge in interface MutableDirectedGraph<N>

Parameters:

from - out node for the edge to remove.

to - in node for the edge to remove.

containsEdge

public boolean containsEdge(N from,
                            N to)

Specified by:

containsEdge in interface MutableDirectedGraph<N>

Returns:

true if the graph contains an edge the 2 nodes false otherwise.

containsNode

public boolean containsNode(N node)

Specified by:

containsNode in interface MutableDirectedGraph<N>

Parameters:

node - node that we want to know if the graph constains.

Returns:

true if the graph contains the node. false otherwise.

getNodes

public List<N> getNodes()

Specified by:

getNodes in interface MutableDirectedGraph<N>

Returns:

a list of the nodes that compose the graph. No ordering is implied.

addNode

public void addNode(N node)

Description copied from interface: MutableDirectedGraph

Adds a node to the graph. Initially the added node has no successors or predecessors. ; as a consequence it is considered both a head and tail for the graph.

Specified by:

addNode in interface MutableDirectedGraph<N>

Parameters:

node - a node to add to the graph.

See Also:

DirectedGraph.getHeads(), DirectedGraph.getTails()

removeNode

public void removeNode(N node)

Description copied from interface: MutableDirectedGraph

Removes a node from the graph. If the node is not found in the graph, no change is made.

Specified by:

removeNode in interface MutableDirectedGraph<N>

Parameters:

node - the node to be removed.

printGraph

public void printGraph()