soot.toolkits.graph

Class HashMutableEdgeLabelledDirectedGraph<N,L>

java.lang.Object

soot.toolkits.graph.HashMutableEdgeLabelledDirectedGraph<N,L>

Type Parameters:

N -

L -

All Implemented Interfaces:

java.lang.Iterable<N>, DirectedGraph<N>, EdgeLabelledDirectedGraph<N,L>, MutableEdgeLabelledDirectedGraph<N,L>

Direct Known Subclasses:

HashMutablePDG

public class HashMutableEdgeLabelledDirectedGraph<N,L>
extends java.lang.Object
implements MutableEdgeLabelledDirectedGraph<N,L>

HashMap based implementation of a MutableEdgeLabelledDirectedGraph.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<soot.toolkits.graph.HashMutableEdgeLabelledDirectedGraph.DGEdge<N>,java.util.List<L>>	edgeToLabels
protected java.util.Set<N>	heads
protected java.util.Map<L,java.util.List<soot.toolkits.graph.HashMutableEdgeLabelledDirectedGraph.DGEdge<N>>>	labelToEdges
protected java.util.Map<N,java.util.List<N>>	nodeToPreds
protected java.util.Map<N,java.util.List<N>>	nodeToSuccs
protected java.util.Set<N>	tails

Constructor Summary

Constructors

Constructor and Description
HashMutableEdgeLabelledDirectedGraph()

Method Summary

Modifier and Type	Method and Description
void	addEdge(N from, N to, L label) 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.
HashMutableEdgeLabelledDirectedGraph<N,L>	clone()
boolean	containsAnyEdge(L label)
boolean	containsAnyEdge(N from, N to)
boolean	containsEdge(N from, N to, L label)
boolean	containsNode(N node)
MutableDirectedGraph<N>	getEdgesForLabel(L label) Returns a DirectedGraph consisting of all edges with the given label and their nodes.
java.util.List<N>	getHeads() Returns a list of entry points for this graph.
java.util.List<L>	getLabelsForEdges(N from, N to) Returns a list of labels for which an edge exists between from and to
java.util.List<N>	getPredsOf(N s) Returns a list of predecessors for the given node in the graph.
java.util.List<N>	getSuccsOf(N s) Returns a list of successors for the given node in the graph.
java.util.List<N>	getTails() Returns a list of exit points for this graph.
java.util.Iterator<N>	iterator() Returns an iterator for the nodes in this graph.
void	printGraph()
void	removeAllEdges(L label) Removes all edges with the given label in the graph.
void	removeAllEdges(N from, N to) Removes all edges between 2 nodes in the graph.
void	removeEdge(N from, N to, L label) 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 java.util.Map<N,java.util.List<N>> nodeToPreds

nodeToSuccs

protected java.util.Map<N,java.util.List<N>> nodeToSuccs

edgeToLabels

protected java.util.Map<soot.toolkits.graph.HashMutableEdgeLabelledDirectedGraph.DGEdge<N>,java.util.List<L>> edgeToLabels

labelToEdges

protected java.util.Map<L,java.util.List<soot.toolkits.graph.HashMutableEdgeLabelledDirectedGraph.DGEdge<N>>> labelToEdges

heads

protected java.util.Set<N> heads

tails

protected java.util.Set<N> tails

Constructor Detail

HashMutableEdgeLabelledDirectedGraph

public HashMutableEdgeLabelledDirectedGraph()

Method Detail

clearAll

public void clearAll()

Removes all nodes and edges.

clone

public HashMutableEdgeLabelledDirectedGraph<N,L> clone()

Overrides:

clone in class java.lang.Object

getHeads

public java.util.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 java.util.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 java.util.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>

getSuccsOf

public java.util.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>

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 java.util.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 java.lang.Iterable<N>

Specified by:

iterator in interface DirectedGraph<N>

addEdge

public void addEdge(N from,
                    N to,
                    L label)

Description copied from interface: MutableEdgeLabelledDirectedGraph

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

Specified by:

addEdge in interface MutableEdgeLabelledDirectedGraph<N,L>

Parameters:

from - out node for the edge.

to - in node for the edge.

label - label for the edge.

getLabelsForEdges

public java.util.List<L> getLabelsForEdges(N from,
                                           N to)

Description copied from interface: EdgeLabelledDirectedGraph

Returns a list of labels for which an edge exists between from and to

Specified by:

getLabelsForEdges in interface EdgeLabelledDirectedGraph<N,L>

Parameters:

from - out node of the edges to get labels for

to - in node of the edges to get labels for

Returns:

getEdgesForLabel

public MutableDirectedGraph<N> getEdgesForLabel(L label)

Description copied from interface: EdgeLabelledDirectedGraph

Returns a DirectedGraph consisting of all edges with the given label and their nodes. Nodes without edges are not included in the new graph.

Specified by:

getEdgesForLabel in interface EdgeLabelledDirectedGraph<N,L>

Parameters:

label - edge label to use as a filter in building the subgraph

Returns:

removeEdge

public void removeEdge(N from,
                       N to,
                       L label)

Description copied from interface: MutableEdgeLabelledDirectedGraph

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

Specified by:

removeEdge in interface MutableEdgeLabelledDirectedGraph<N,L>

Parameters:

from - out node for the edges to remove.

to - in node for the edges to remove.

label - label for the edge to remove.

removeAllEdges

public void removeAllEdges(N from,
                           N to)

Description copied from interface: MutableEdgeLabelledDirectedGraph

Removes all edges between 2 nodes in the graph. If no edges are present, no change is made.

Specified by:

removeAllEdges in interface MutableEdgeLabelledDirectedGraph<N,L>

Parameters:

from - out node for the edges to remove.

to - in node for the edges to remove.

removeAllEdges

public void removeAllEdges(L label)

Description copied from interface: MutableEdgeLabelledDirectedGraph

Removes all edges with the given label in the graph. If no edges are present, no change is made.

Specified by:

removeAllEdges in interface MutableEdgeLabelledDirectedGraph<N,L>

Parameters:

label - label for the edge to remove.

containsEdge

public boolean containsEdge(N from,
                            N to,
                            L label)

Specified by:

containsEdge in interface EdgeLabelledDirectedGraph<N,L>

Returns:

true if the graph contains an edge between the 2 nodes with the given label, false otherwise

containsAnyEdge

public boolean containsAnyEdge(N from,
                               N to)

Specified by:

containsAnyEdge in interface EdgeLabelledDirectedGraph<N,L>

Parameters:

from - out node for the edges

to - in node for the edges

Returns:

true if the graph contains any edges between the 2 nodes, false, otherwise

containsAnyEdge

public boolean containsAnyEdge(L label)

Specified by:

containsAnyEdge in interface EdgeLabelledDirectedGraph<N,L>

Parameters:

label - label for the edges

Returns:

true if the graph contains any edges with the given label, false otherwise

containsNode

public boolean containsNode(N node)

Specified by:

containsNode in interface EdgeLabelledDirectedGraph<N,L>

Parameters:

node - node that we want to know if the graph contains

Returns:

true if the graph contains the node, false otherwise

addNode

public void addNode(N node)

Description copied from interface: MutableEdgeLabelledDirectedGraph

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 MutableEdgeLabelledDirectedGraph<N,L>

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: MutableEdgeLabelledDirectedGraph

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

Specified by:

removeNode in interface MutableEdgeLabelledDirectedGraph<N,L>

Parameters:

node - the node to be removed.

printGraph

public void printGraph()