Interface Graph<N>
-
- Type Parameters:
N
- Node parameter type
- All Known Subinterfaces:
MutableGraph<N>
,MutableValueGraph<N,V>
,ValueGraph<N,V>
- All Known Implementing Classes:
AbstractGraph
,AbstractValueGraph
,ImmutableGraph
,ImmutableValueGraph
@Beta public interface Graph<N>
An interface for graph-structured data, whose edges are anonymous entities with no identity or information of their own.A graph is composed of a set of nodes and a set of edges connecting pairs of nodes.
There are three main interfaces provided to represent graphs. In order of increasing complexity they are:
Graph
,ValueGraph
, andNetwork
. You should generally prefer the simplest interface that satisfies your use case. See the "Choosing the right graph type" section of the Guava User Guide for more details.Capabilities
Graph
supports the following use cases (definitions of terms):- directed graphs
- undirected graphs
- graphs that do/don't allow self-loops
- graphs whose nodes/edges are insertion-ordered, sorted, or unordered
Graph
explicitly does not support parallel edges, and forbids implementations or extensions with parallel edges. If you need parallel edges, useNetwork
.Building a
Graph
The implementation classes that `common.graph` provides are not public, by design. To create an instance of one of the built-in implementations of
Graph
, use theGraphBuilder
class:MutableGraph<Integer> graph = GraphBuilder.undirected().build();
GraphBuilder.build()
returns an instance ofMutableGraph
, which is a subtype ofGraph
that provides methods for adding and removing nodes and edges. If you do not need to mutate a graph (e.g. if you write a method than runs a read-only algorithm on the graph), you should use the non-mutatingGraph
interface, or anImmutableGraph
.You can create an immutable copy of an existing
Graph
usingImmutableGraph.copyOf(Graph)
:ImmutableGraph<Integer> immutableGraph = ImmutableGraph.copyOf(graph);
Instances of
ImmutableGraph
do not implementMutableGraph
(obviously!) and are contractually guaranteed to be unmodifiable and thread-safe.The Guava User Guide has more information on (and examples of) building graphs.
Additional documentation
See the Guava User Guide for the
common.graph
package ("Graphs Explained") for additional documentation, including:- Since:
- 20.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Set<N>
adjacentNodes(java.lang.Object node)
Returns the nodes which have an incident edge in common withnode
in this graph.boolean
allowsSelfLoops()
Returns true if this graph allows self-loops (edges that connect a node to itself).int
degree(java.lang.Object node)
Returns the count ofnode
's incident edges, counting self-loops twice (equivalently, the number of times an edge touchesnode
).java.util.Set<EndpointPair<N>>
edges()
Returns all edges in this graph.boolean
equals(java.lang.Object object)
For the defaultGraph
implementations, returns true ifthis == object
(reference equality).int
hashCode()
For the defaultGraph
implementations, returnsSystem.identityHashCode(this)
.int
inDegree(java.lang.Object node)
Returns the count ofnode
's incoming edges (equal topredecessors(node).size()
) in a directed graph.boolean
isDirected()
Returns true if the edges in this graph are directed.ElementOrder<N>
nodeOrder()
Returns the order of iteration for the elements ofnodes()
.java.util.Set<N>
nodes()
Returns all nodes in this graph, in the order specified bynodeOrder()
.int
outDegree(java.lang.Object node)
Returns the count ofnode
's outgoing edges (equal tosuccessors(node).size()
) in a directed graph.java.util.Set<N>
predecessors(java.lang.Object node)
Returns all nodes in this graph adjacent tonode
which can be reached by traversingnode
's incoming edges against the direction (if any) of the edge.java.util.Set<N>
successors(java.lang.Object node)
Returns all nodes in this graph adjacent tonode
which can be reached by traversingnode
's outgoing edges in the direction (if any) of the edge.
-
-
-
Method Detail
-
nodes
java.util.Set<N> nodes()
Returns all nodes in this graph, in the order specified bynodeOrder()
.
-
edges
java.util.Set<EndpointPair<N>> edges()
Returns all edges in this graph.
-
isDirected
boolean isDirected()
Returns true if the edges in this graph are directed. Directed edges connect asource node
to atarget node
, while undirected edges connect a pair of nodes to each other.
-
allowsSelfLoops
boolean allowsSelfLoops()
Returns true if this graph allows self-loops (edges that connect a node to itself). Attempting to add a self-loop to a graph that does not allow them will throw anUnsupportedOperationException
.
-
nodeOrder
ElementOrder<N> nodeOrder()
Returns the order of iteration for the elements ofnodes()
.
-
adjacentNodes
java.util.Set<N> adjacentNodes(java.lang.Object node)
Returns the nodes which have an incident edge in common withnode
in this graph.- Throws:
java.lang.IllegalArgumentException
- ifnode
is not an element of this graph
-
predecessors
java.util.Set<N> predecessors(java.lang.Object node)
Returns all nodes in this graph adjacent tonode
which can be reached by traversingnode
's incoming edges against the direction (if any) of the edge.In an undirected graph, this is equivalent to
adjacentNodes(Object)
.- Throws:
java.lang.IllegalArgumentException
- ifnode
is not an element of this graph
-
successors
java.util.Set<N> successors(java.lang.Object node)
Returns all nodes in this graph adjacent tonode
which can be reached by traversingnode
's outgoing edges in the direction (if any) of the edge.In an undirected graph, this is equivalent to
adjacentNodes(Object)
.This is not the same as "all nodes reachable from
node
by following outgoing edges". For that functionality, seeGraphs.reachableNodes(Graph, Object)
.- Throws:
java.lang.IllegalArgumentException
- ifnode
is not an element of this graph
-
degree
int degree(java.lang.Object node)
Returns the count ofnode
's incident edges, counting self-loops twice (equivalently, the number of times an edge touchesnode
).For directed graphs, this is equal to
inDegree(node) + outDegree(node)
.For undirected graphs, this is equal to
adjacentNodes(node).size()
+ (1 ifnode
has an incident self-loop, 0 otherwise).If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.- Throws:
java.lang.IllegalArgumentException
- ifnode
is not an element of this graph
-
inDegree
int inDegree(java.lang.Object node)
Returns the count ofnode
's incoming edges (equal topredecessors(node).size()
) in a directed graph. In an undirected graph, returns thedegree(Object)
.If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.- Throws:
java.lang.IllegalArgumentException
- ifnode
is not an element of this graph
-
outDegree
int outDegree(java.lang.Object node)
Returns the count ofnode
's outgoing edges (equal tosuccessors(node).size()
) in a directed graph. In an undirected graph, returns thedegree(Object)
.If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.- Throws:
java.lang.IllegalArgumentException
- ifnode
is not an element of this graph
-
equals
boolean equals(@Nullable java.lang.Object object)
For the defaultGraph
implementations, returns true ifthis == object
(reference equality). External implementations are free to define this method as they see fit, as long as they satisfy theObject.equals(Object)
contract.To compare two
Graph
s based on their contents rather than their references, seeGraphs.equivalent(Graph, Graph)
.- Overrides:
equals
in classjava.lang.Object
-
hashCode
int hashCode()
For the defaultGraph
implementations, returnsSystem.identityHashCode(this)
. External implementations are free to define this method as they see fit, as long as they satisfy theObject.hashCode()
contract.- Overrides:
hashCode
in classjava.lang.Object
-
-