Package com.google.javascript.jscomp.graph

Class LinkedDirectedGraph<N,E>

java.lang.Object

com.google.javascript.jscomp.graph.Graph<N,E>

com.google.javascript.jscomp.graph.DiGraph<N,E>

com.google.javascript.jscomp.graph.LinkedDirectedGraph<N,E>

Type Parameters:

N - Value type that the graph node stores.

E - Value type that the graph edge stores.

All Implemented Interfaces:

AdjacencyGraph<N,E>, GraphvizGraph

Direct Known Subclasses:

ControlFlowGraph

public class LinkedDirectedGraph<N,E>
extends DiGraph<N,E>
implements GraphvizGraph

A directed graph using ArrayLists within nodes to store edge information.

This implementation favors directed graph operations inherited from DirectedGraph. Operations from Graph would tend to be slower.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LinkedDirectedGraph.LinkedDiGraphEdge<N,E>	A directed graph edge that stores the source and destination nodes at each edge.
static class	LinkedDirectedGraph.LinkedDiGraphNode<N,E>	A directed graph node that stores outgoing edges and incoming edges as an list within the node itself.

Nested classes/interfaces inherited from class com.google.javascript.jscomp.graph.DiGraph

DiGraph.DiGraphEdge<N,E>, DiGraph.DiGraphNode<N,E>

Nested classes/interfaces inherited from class com.google.javascript.jscomp.graph.Graph

Graph.GraphEdge<N,E>

Nested classes/interfaces inherited from interface com.google.javascript.jscomp.graph.GraphvizGraph

GraphvizGraph.GraphvizEdge, GraphvizGraph.GraphvizNode

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<N,LinkedDirectedGraph.LinkedDiGraphNode<N,E>>	nodes

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LinkedDirectedGraph(boolean useNodeAnnotations, boolean useEdgeAnnotations)

Method Summary

Modifier and Type	Method	Description
void	connect(DiGraph.DiGraphNode<N,E> src, E edgeValue, DiGraph.DiGraphNode<N,E> dest)	DiGraphNode look ups can be expensive for a large graph operation, prefer this method if you have the DiGraphNode available.
void	connect(N srcValue, E edgeValue, N destValue)	Connects two nodes in the graph with an edge.
void	connectIfNotConnectedInDirection(N srcValue, E edgeValue, N destValue)	DiGraphNode look ups can be expensive for a large graph operation, prefer this method if you have the DiGraphNode available.
static <N, E> LinkedDirectedGraph<N,E>	create()
LinkedDirectedGraph.LinkedDiGraphNode<N,E>	createNode(N nodeValue)	Gets a node from the graph given a value.
static <N, E> LinkedDirectedGraph<N,E>	createWithoutAnnotations()
void	disconnect(N n1, N n2)	Disconnects two nodes in the graph by removing all edges between them.
void	disconnectInDirection(N srcValue, N destValue)	Disconnects all edges from n1 to n2.
List<LinkedDirectedGraph.LinkedDiGraphNode<N,E>>	getDirectedPredNodes(DiGraph.DiGraphNode<N,E> dNode)
List<LinkedDirectedGraph.LinkedDiGraphNode<N,E>>	getDirectedPredNodes(N nodeValue)
List<LinkedDirectedGraph.LinkedDiGraphNode<N,E>>	getDirectedSuccNodes(DiGraph.DiGraphNode<N,E> dNode)
List<LinkedDirectedGraph.LinkedDiGraphNode<N,E>>	getDirectedSuccNodes(N nodeValue)
List<LinkedDirectedGraph.LinkedDiGraphEdge<N,E>>	getEdges()	Gets an immutable list of all edges.
List<LinkedDirectedGraph.LinkedDiGraphEdge<N,E>>	getEdges(N n1, N n2)	Retrieves an edge from the graph.
List<LinkedDirectedGraph.LinkedDiGraphEdge<N,E>>	getEdgesInDirection(N n1, N n2)
@Nullable Graph.GraphEdge<N,E>	getFirstEdge(N n1, N n2)	Retrieves any edge from the graph.
List<GraphvizGraph.GraphvizEdge>	getGraphvizEdges()	Retrieve a list of edges in the graph.
List<GraphvizGraph.GraphvizNode>	getGraphvizNodes()	Retrieve a list of nodes in the graph.
List<LinkedDirectedGraph.LinkedDiGraphEdge<N,E>>	getInEdges(N nodeValue)	Gets an immutable list of in edges of the given node.
String	getName()	Name of the graph.
List<GraphNode<N,E>>	getNeighborNodes(N value)	Gets the neighboring nodes.
LinkedDirectedGraph.LinkedDiGraphNode<N,E>	getNode(N nodeValue)	Gets a node from the graph given a value.
int	getNodeCount()
int	getNodeDegree(N value)	Gets the degree of a node.
Collection<LinkedDirectedGraph.LinkedDiGraphNode<N,E>>	getNodes()	Gets an immutable list of all nodes.
List<LinkedDirectedGraph.LinkedDiGraphEdge<N,E>>	getOutEdges(N nodeValue)	Gets an immutable list of out edges of the given node.
boolean	isConnectedInDirection(LinkedDirectedGraph.LinkedDiGraphNode<N,E> source, com.google.common.base.Predicate<E> edgeFilter, LinkedDirectedGraph.LinkedDiGraphNode<N,E> dest)	DiGraphNode look ups can be expensive for a large graph operation, prefer this method if you have the DiGraphNodes available.
boolean	isConnectedInDirection(N source, E edgeValue, N dest)	DiGraphNode look ups can be expensive for a large graph operation, prefer the version below that takes DiGraphNodes, if you have them available.
boolean	isConnectedInDirection(N source, N dest)	DiGraphNode look ups can be expensive for a large graph operation, prefer the version below that takes DiGraphNodes, if you have them available.
boolean	isDirected()	Graph type.
SubGraph<N,E>	newSubGraph()	Returns an empty SubGraph for this Graph.

Methods inherited from class com.google.javascript.jscomp.graph.DiGraph

isConnected, isConnected

Methods inherited from class com.google.javascript.jscomp.graph.Graph

clearEdgeAnnotations, clearNodeAnnotations, connectIfNotFound, getWeight, hasNode, popEdgeAnnotations, popNodeAnnotations, pushEdgeAnnotations, pushNodeAnnotations

Methods inherited from class java.lang.Object

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

Field Details

nodes

protected final Map<N,LinkedDirectedGraph.LinkedDiGraphNode<N,E>> nodes

Constructor Details

LinkedDirectedGraph

protected LinkedDirectedGraph(boolean useNodeAnnotations,
 boolean useEdgeAnnotations)

Method Details

newSubGraph

public SubGraph<N,E> newSubGraph()

Description copied from interface: AdjacencyGraph

Returns an empty SubGraph for this Graph.

Specified by:

newSubGraph in interface AdjacencyGraph<N,E>

createWithoutAnnotations

public static <N,
E> LinkedDirectedGraph<N,E> createWithoutAnnotations()

create

public static <N,
E> LinkedDirectedGraph<N,E> create()

connect

public void connect(N srcValue,
 E edgeValue,
 N destValue)

Description copied from class: Graph

Connects two nodes in the graph with an edge.

Specified by:

connect in class Graph<N,E>

Parameters:

srcValue - First node.

edgeValue - The edge.

destValue - Second node.

connect

public void connect(DiGraph.DiGraphNode<N,E> src,
 E edgeValue,
 DiGraph.DiGraphNode<N,E> dest)

DiGraphNode look ups can be expensive for a large graph operation, prefer this method if you have the DiGraphNode available.

connectIfNotConnectedInDirection

public void connectIfNotConnectedInDirection(N srcValue,
 E edgeValue,
 N destValue)

DiGraphNode look ups can be expensive for a large graph operation, prefer this method if you have the DiGraphNode available.

disconnect

public void disconnect(N n1,
 N n2)

Description copied from class: Graph

Disconnects two nodes in the graph by removing all edges between them.

Specified by:

disconnect in class Graph<N,E>

Parameters:

n1 - First node.

n2 - Second node.

disconnectInDirection

public void disconnectInDirection(N srcValue,
 N destValue)

Description copied from class: DiGraph

Disconnects all edges from n1 to n2.

Specified by:

disconnectInDirection in class DiGraph<N,E>

Parameters:

srcValue - Source node.

destValue - Destination node.

getNodes

public Collection<LinkedDirectedGraph.LinkedDiGraphNode<N,E>> getNodes()

Description copied from class: Graph

Gets an immutable list of all nodes.

Specified by:

getNodes in interface AdjacencyGraph<N,E>

Specified by:

getNodes in class DiGraph<N,E>

getNode

public LinkedDirectedGraph.LinkedDiGraphNode<N,E> getNode(N nodeValue)

Description copied from interface: AdjacencyGraph

Gets a node from the graph given a value. Values equality are compared using Object.equals.

Specified by:

getNode in interface AdjacencyGraph<N,E>

Specified by:

getNode in class DiGraph<N,E>

Parameters:

nodeValue - The node's value.

Returns:

The corresponding node in the graph, null if there value has no corresponding node.

getInEdges

public List<LinkedDirectedGraph.LinkedDiGraphEdge<N,E>> getInEdges(N nodeValue)

Description copied from class: DiGraph

Gets an immutable list of in edges of the given node.

Specified by:

getInEdges in class DiGraph<N,E>

getOutEdges

public List<LinkedDirectedGraph.LinkedDiGraphEdge<N,E>> getOutEdges(N nodeValue)

Description copied from class: DiGraph

Gets an immutable list of out edges of the given node.

Specified by:

getOutEdges in class DiGraph<N,E>

createNode

public LinkedDirectedGraph.LinkedDiGraphNode<N,E> createNode(N nodeValue)

Description copied from class: Graph

Gets a node from the graph given a value. New nodes are created if that value has not been assigned a graph node. Values equality are compared using Object.equals.

Specified by:

createNode in class DiGraph<N,E>

Parameters:

nodeValue - The node's value.

Returns:

The corresponding node in the graph.

getEdges

public List<LinkedDirectedGraph.LinkedDiGraphEdge<N,E>> getEdges(N n1,
 N n2)

Description copied from class: Graph

Retrieves an edge from the graph.

Specified by:

getEdges in class DiGraph<N,E>

Parameters:

n1 - Node one.

n2 - Node two.

Returns:

The list of edges between those two values in the graph.

getEdges

public List<LinkedDirectedGraph.LinkedDiGraphEdge<N,E>> getEdges()

Description copied from class: Graph

Gets an immutable list of all edges.

Specified by:

getEdges in class DiGraph<N,E>

getFirstEdge

public @Nullable Graph.GraphEdge<N,E> getFirstEdge(N n1,
 N n2)

Description copied from class: Graph

Retrieves any edge from the graph.

Specified by:

getFirstEdge in class Graph<N,E>

Parameters:

n1 - Node one.

n2 - Node two.

Returns:

The first edges between those two values in the graph. null if there are none.

getEdgesInDirection

public List<LinkedDirectedGraph.LinkedDiGraphEdge<N,E>> getEdgesInDirection(N n1,
 N n2)

Specified by:

getEdgesInDirection in class DiGraph<N,E>

isConnectedInDirection

public boolean isConnectedInDirection(N source,
 N dest)

DiGraphNode look ups can be expensive for a large graph operation, prefer the version below that takes DiGraphNodes, if you have them available.

Specified by:

isConnectedInDirection in class DiGraph<N,E>

Parameters:

source - the source node from which we traverse outwards

dest - Node 2.

Returns:

true if the graph contains edge from n1 to n2.

isConnectedInDirection

public boolean isConnectedInDirection(N source,
 E edgeValue,
 N dest)

DiGraphNode look ups can be expensive for a large graph operation, prefer the version below that takes DiGraphNodes, if you have them available.

Specified by:

isConnectedInDirection in class DiGraph<N,E>

Parameters:

source - the source node from which we traverse outwards

edgeValue - only edges equal to the given value will be traversed

dest - Node 2.

Returns:

true if the edge exists.

isConnectedInDirection

public boolean isConnectedInDirection(LinkedDirectedGraph.LinkedDiGraphNode<N,E> source,
 com.google.common.base.Predicate<E> edgeFilter,
 LinkedDirectedGraph.LinkedDiGraphNode<N,E> dest)

DiGraphNode look ups can be expensive for a large graph operation, prefer this method if you have the DiGraphNodes available.

Parameters:

source - the source node from which we traverse outwards

edgeFilter - only edges matching this filter will be traversed

dest - the destination node

getDirectedPredNodes

public List<LinkedDirectedGraph.LinkedDiGraphNode<N,E>> getDirectedPredNodes(N nodeValue)

Specified by:

getDirectedPredNodes in class DiGraph<N,E>

getDirectedPredNodes

public List<LinkedDirectedGraph.LinkedDiGraphNode<N,E>> getDirectedPredNodes(DiGraph.DiGraphNode<N,E> dNode)

Specified by:

getDirectedPredNodes in class DiGraph<N,E>

getDirectedSuccNodes

public List<LinkedDirectedGraph.LinkedDiGraphNode<N,E>> getDirectedSuccNodes(N nodeValue)

Specified by:

getDirectedSuccNodes in class DiGraph<N,E>

getDirectedSuccNodes

public List<LinkedDirectedGraph.LinkedDiGraphNode<N,E>> getDirectedSuccNodes(DiGraph.DiGraphNode<N,E> dNode)

Specified by:

getDirectedSuccNodes in class DiGraph<N,E>

getGraphvizEdges

public List<GraphvizGraph.GraphvizEdge> getGraphvizEdges()

Description copied from interface: GraphvizGraph

Retrieve a list of edges in the graph.

Specified by:

getGraphvizEdges in interface GraphvizGraph

Returns:

A list of edges in the graph.

getGraphvizNodes

public List<GraphvizGraph.GraphvizNode> getGraphvizNodes()

Description copied from interface: GraphvizGraph

Retrieve a list of nodes in the graph.

Specified by:

getGraphvizNodes in interface GraphvizGraph

Returns:

A list of nodes in the graph.

getName

public String getName()

Description copied from interface: GraphvizGraph

Name of the graph.

Specified by:

getName in interface GraphvizGraph

Returns:

Name of the graph.

isDirected

public boolean isDirected()

Description copied from interface: GraphvizGraph

Graph type.

Specified by:

isDirected in interface GraphvizGraph

Returns:

True if the graph is a directed graph.

getNodeCount

public int getNodeCount()

Specified by:

getNodeCount in interface AdjacencyGraph<N,E>

Specified by:

getNodeCount in class Graph<N,E>

getNeighborNodes

public List<GraphNode<N,E>> getNeighborNodes(N value)

Description copied from class: Graph

Gets the neighboring nodes.

Specified by:

getNeighborNodes in class Graph<N,E>

Parameters:

value - The node's value.

Returns:

A list of neighboring nodes.

getNodeDegree

public int getNodeDegree(N value)

Description copied from class: Graph

Gets the degree of a node.

Specified by:

getNodeDegree in class Graph<N,E>

Parameters:

value - The node's value.

Returns:

The degree of the node.