Package com.ibm.wala.util.graph.impl

Class SparseNumberedEdgeManager<T>

java.lang.Object

com.ibm.wala.util.graph.impl.SparseNumberedEdgeManager<T>

All Implemented Interfaces:

EdgeManager<T>, NumberedEdgeManager<T>, Serializable

public final class SparseNumberedEdgeManager<T>
extends Object
implements NumberedEdgeManager<T>, Serializable

An object which tracks edges for nodes that have numbers.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SparseNumberedEdgeManager(NumberedNodeManager<T> nodeManager)
SparseNumberedEdgeManager(NumberedNodeManager<T> nodeManager, int normalCase, byte delegateImpl)	If normalOutCount == n, this edge manager will eagerly allocated n words to hold out edges for each node.

Method Summary

Modifier and Type	Method	Description
void	addEdge(T src, T dst)
int	getPredNodeCount(T N)	Return the number of immediate predecessor nodes of n
IntSet	getPredNodeNumbers(@Nullable T node)
Iterator<T>	getPredNodes(@Nullable T N)	Return an Iterator over the immediate predecessor nodes of n
int	getSuccNodeCount(int number)
int	getSuccNodeCount(T N)	Return the number of immediate successor nodes of this Node in the Graph
IntSet	getSuccNodeNumbers(@Nullable T node)
Iterator<T>	getSuccNodes(int number)
Iterator<T>	getSuccNodes(@Nullable T N)	Return an Iterator over the immediate successor nodes of n
boolean	hasAnySuccessor(int node)	This is implemented as a shortcut for efficiency
boolean	hasEdge(@Nullable T src, @Nullable T dst)
void	removeAllIncidentEdges(T node)
void	removeEdge(T src, T dst)
void	removeIncomingEdges(T node)
void	removeOutgoingEdges(T node)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SparseNumberedEdgeManager

public SparseNumberedEdgeManager(NumberedNodeManager<T> nodeManager)

Parameters:

nodeManager - an object to track nodes

SparseNumberedEdgeManager

public SparseNumberedEdgeManager(NumberedNodeManager<T> nodeManager,
                                 int normalCase,
                                 byte delegateImpl)
                          throws IllegalArgumentException

If normalOutCount == n, this edge manager will eagerly allocated n words to hold out edges for each node. (performance optimization for time)

Parameters:

nodeManager - an object to track nodes

normalCase - what is the "normal" number of out edges for a node?

Throws:

IllegalArgumentException - if normalCase < 0

Method Detail

getPredNodes

public Iterator<T> getPredNodes(@Nullable T N)
                         throws IllegalArgumentException

Description copied from interface: EdgeManager

Return an Iterator over the immediate predecessor nodes of n

This method never returns null.

Specified by:

getPredNodes in interface EdgeManager<T>

Returns:

an Iterator over the immediate predecessor nodes of this Node.

Throws:

IllegalArgumentException

See Also:

EdgeManager.getPredNodes(java.lang.Object)

getPredNodeCount

public int getPredNodeCount(T N)
                     throws IllegalArgumentException

Description copied from interface: EdgeManager

Return the number of immediate predecessor nodes of n

Specified by:

getPredNodeCount in interface EdgeManager<T>

Returns:

the number of immediate predecessors of n.

Throws:

IllegalArgumentException

See Also:

EdgeManager.getPredNodeCount(java.lang.Object)

getSuccNodes

public Iterator<T> getSuccNodes(@Nullable T N)
                         throws IllegalArgumentException

Description copied from interface: EdgeManager

Return an Iterator over the immediate successor nodes of n

This method never returns null.

Specified by:

getSuccNodes in interface EdgeManager<T>

Returns:

an Iterator over the immediate successor nodes of n

Throws:

IllegalArgumentException

See Also:

EdgeManager.getSuccNodes(java.lang.Object)

getSuccNodes

public Iterator<T> getSuccNodes(int number)

See Also:

EdgeManager.getSuccNodes(java.lang.Object)

getSuccNodeNumbers

public IntSet getSuccNodeNumbers(@Nullable T node)
                          throws IllegalArgumentException

Specified by:

getSuccNodeNumbers in interface NumberedEdgeManager<T>

Returns:

the numbers identifying the immediate successors of node

Throws:

IllegalArgumentException

getPredNodeNumbers

public IntSet getPredNodeNumbers(@Nullable T node)
                          throws IllegalArgumentException

Specified by:

getPredNodeNumbers in interface NumberedEdgeManager<T>

Returns:

the numbers identifying the immediate predecessors of node

Throws:

IllegalArgumentException

getSuccNodeCount

public int getSuccNodeCount(T N)
                     throws IllegalArgumentException

Description copied from interface: EdgeManager

Return the number of immediate successor nodes of this Node in the Graph

Specified by:

getSuccNodeCount in interface EdgeManager<T>

Returns:

the number of immediate successor Nodes of this Node in the Graph.

Throws:

IllegalArgumentException

See Also:

EdgeManager.getSuccNodeCount(java.lang.Object)

getSuccNodeCount

public int getSuccNodeCount(int number)

See Also:

EdgeManager.getSuccNodeCount(java.lang.Object)

addEdge

public void addEdge(T src,
                    T dst)
             throws IllegalArgumentException

Specified by:

addEdge in interface EdgeManager<T>

Throws:

IllegalArgumentException

See Also:

EdgeManager.addEdge(java.lang.Object, java.lang.Object)

hasEdge

public boolean hasEdge(@Nullable T src,
                       @Nullable T dst)

Specified by:

hasEdge in interface EdgeManager<T>

removeAllIncidentEdges

public void removeAllIncidentEdges(T node)
                            throws IllegalArgumentException

Specified by:

removeAllIncidentEdges in interface EdgeManager<T>

Throws:

IllegalArgumentException

See Also:

EdgeManager.removeAllIncidentEdges(Object)

removeIncomingEdges

public void removeIncomingEdges(T node)
                         throws IllegalArgumentException

Specified by:

removeIncomingEdges in interface EdgeManager<T>

Throws:

IllegalArgumentException

See Also:

EdgeManager.removeAllIncidentEdges(Object)

removeEdge

public void removeEdge(T src,
                       T dst)
                throws IllegalArgumentException

Specified by:

removeEdge in interface EdgeManager<T>

Throws:

IllegalArgumentException

removeOutgoingEdges

public void removeOutgoingEdges(T node)
                         throws IllegalArgumentException

Specified by:

removeOutgoingEdges in interface EdgeManager<T>

Throws:

IllegalArgumentException

See Also:

EdgeManager.removeAllIncidentEdges(Object)

hasAnySuccessor

public boolean hasAnySuccessor(int node)

This is implemented as a shortcut for efficiency

Returns:

true iff that node has any successors

toString

public String toString()

Overrides:

toString in class Object