Interface ValueGraph<N,V>

 Type Parameters:
N
 Node parameter typeV
 Value parameter type
 All Superinterfaces:
PredecessorsFunction<N>
,SuccessorsFunction<N>
 All Known Subinterfaces:
MutableValueGraph<N,V>
 All Known Implementing Classes:
AbstractValueGraph
,ImmutableValueGraph
@Beta public interface ValueGraph<N,V>
An interface for graphstructured data, whose edges have associated nonunique values.A graph is composed of a set of nodes and a set of edges connecting pairs of nodes.
There are three primary 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
ValueGraph
supports the following use cases (definitions of terms): directed graphs
 undirected graphs
 graphs that do/don't allow selfloops
 graphs whose nodes/edges are insertionordered, sorted, or unordered
 graphs whose edges have associated values
ValueGraph
, as a subtype ofGraph
, explicitly does not support parallel edges, and forbids implementations or extensions with parallel edges. If you need parallel edges, useNetwork
. (You can use a positiveInteger
edge value as a loose representation of edge multiplicity, but the*degree()
and mutation methods will not reflect your interpretation of the edge value as its multiplicity.)Building a
ValueGraph
The implementation classes that
common.graph
provides are not public, by design. To create an instance of one of the builtin implementations ofValueGraph
, use theValueGraphBuilder
class:MutableValueGraph<Integer, Double> graph = ValueGraphBuilder.directed().build();
ValueGraphBuilder.build()
returns an instance ofMutableValueGraph
, which is a subtype ofValueGraph
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 readonly algorithm on the graph), you should use the nonmutatingValueGraph
interface, or anImmutableValueGraph
.You can create an immutable copy of an existing
ValueGraph
usingImmutableValueGraph.copyOf(ValueGraph)
:ImmutableValueGraph<Integer, Double> immutableGraph = ImmutableValueGraph.copyOf(graph);
Instances of
ImmutableValueGraph
do not implementMutableValueGraph
(obviously!) and are contractually guaranteed to be unmodifiable and threadsafe.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
 Author:
 James Sexton, Joshua O'Madadhain


Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Set<N>
adjacentNodes(N node)
Returns a live view of the nodes which have an incident edge in common withnode
in this graph.boolean
allowsSelfLoops()
Returns true if this graph allows selfloops (edges that connect a node to itself).Graph<N>
asGraph()
Returns a live view of this graph as aGraph
.int
degree(N node)
Returns the count ofnode
's incident edges, counting selfloops twice (equivalently, the number of times an edge touchesnode
).java.util.Set<EndpointPair<N>>
edges()
Returns all edges in this graph.java.util.Optional<V>
edgeValue(EndpointPair<N> endpoints)
Returns the value of the edge that connectsendpoints
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsOptional.empty()
.java.util.Optional<V>
edgeValue(N nodeU, N nodeV)
Returns the value of the edge that connectsnodeU
tonodeV
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsOptional.empty()
.V
edgeValueOrDefault(EndpointPair<N> endpoints, V defaultValue)
Returns the value of the edge that connectsendpoints
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsdefaultValue
.V
edgeValueOrDefault(N nodeU, N nodeV, V defaultValue)
Returns the value of the edge that connectsnodeU
tonodeV
, if one is present; otherwise, returnsdefaultValue
.boolean
equals(java.lang.Object object)
Returnstrue
iffobject
is aValueGraph
that has the same elements and the same structural relationships as those in this graph.boolean
hasEdgeConnecting(EndpointPair<N> endpoints)
Returns true if there is an edge that directly connectsendpoints
(in the order, if any, specified byendpoints
).boolean
hasEdgeConnecting(N nodeU, N nodeV)
Returns true if there is an edge that directly connectsnodeU
tonodeV
.int
hashCode()
Returns the hash code for this graph.ElementOrder<N>
incidentEdgeOrder()
Returns anElementOrder
that specifies the order of iteration for the elements ofedges()
,adjacentNodes(Object)
,predecessors(Object)
,successors(Object)
andincidentEdges(Object)
.java.util.Set<EndpointPair<N>>
incidentEdges(N node)
Returns a live view of the edges in this graph whose endpoints includenode
.int
inDegree(N 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(N node)
Returns the count ofnode
's outgoing edges (equal tosuccessors(node).size()
) in a directed graph.java.util.Set<N>
predecessors(N node)
Returns a live view of 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(N node)
Returns a live view of 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.

asGraph
Graph<N> asGraph()
Returns a live view of this graph as aGraph
. The resultingGraph
will have an edge connecting node A to node B if thisValueGraph
has an edge connecting A to B.

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 selfloops (edges that connect a node to itself). Attempting to add a selfloop to a graph that does not allow them will throw anIllegalArgumentException
.

nodeOrder
ElementOrder<N> nodeOrder()
Returns the order of iteration for the elements ofnodes()
.

incidentEdgeOrder
ElementOrder<N> incidentEdgeOrder()
Returns anElementOrder
that specifies the order of iteration for the elements ofedges()
,adjacentNodes(Object)
,predecessors(Object)
,successors(Object)
andincidentEdges(Object)
. Since:
 29.0

adjacentNodes
java.util.Set<N> adjacentNodes(N node)
Returns a live view of the nodes which have an incident edge in common withnode
in this graph.This is equal to the union of
predecessors(Object)
andsuccessors(Object)
.If
node
is removed from the graph after this method is called, theSet
view
returned by this method will be invalidated, and will throwIllegalStateException
if it is accessed in any way, with the following exceptions:view.equals(view)
evaluates totrue
(but any other `equals()` expression involvingview
will throw)hashCode()
does not throw if
node
is readded to the graph after having been removed,view
's behavior is undefined
 Throws:
java.lang.IllegalArgumentException
 ifnode
is not an element of this graph

predecessors
java.util.Set<N> predecessors(N node)
Returns a live view of 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)
.If
node
is removed from the graph after this method is called, the `Set` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way. Specified by:
predecessors
in interfacePredecessorsFunction<N>
 Throws:
java.lang.IllegalArgumentException
 ifnode
is not an element of this graph

successors
java.util.Set<N> successors(N node)
Returns a live view of 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)
.If
node
is removed from the graph after this method is called, theSet
view
returned by this method will be invalidated, and will throwIllegalStateException
if it is accessed in any way, with the following exceptions:view.equals(view)
evaluates totrue
(but any other `equals()` expression involvingview
will throw)hashCode()
does not throw if
node
is readded to the graph after having been removed,view
's behavior is undefined
 Specified by:
successors
in interfaceSuccessorsFunction<N>
 Throws:
java.lang.IllegalArgumentException
 ifnode
is not an element of this graph

incidentEdges
java.util.Set<EndpointPair<N>> incidentEdges(N node)
Returns a live view of the edges in this graph whose endpoints includenode
.This is equal to the union of incoming and outgoing edges.
If
node
is removed from the graph after this method is called, theSet
view
returned by this method will be invalidated, and will throwIllegalStateException
if it is accessed in any way, with the following exceptions:view.equals(view)
evaluates totrue
(but any other `equals()` expression involvingview
will throw)hashCode()
does not throw if
node
is readded to the graph after having been removed,view
's behavior is undefined
 Throws:
java.lang.IllegalArgumentException
 ifnode
is not an element of this graph Since:
 24.0

degree
int degree(N node)
Returns the count ofnode
's incident edges, counting selfloops 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
incidentEdges(node).size()
+ (number of selfloops incident tonode
).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(N 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(N 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

hasEdgeConnecting
boolean hasEdgeConnecting(N nodeU, N nodeV)
Returns true if there is an edge that directly connectsnodeU
tonodeV
. This is equivalent tonodes().contains(nodeU) && successors(nodeU).contains(nodeV)
.In an undirected graph, this is equal to
hasEdgeConnecting(nodeV, nodeU)
. Since:
 23.0

hasEdgeConnecting
boolean hasEdgeConnecting(EndpointPair<N> endpoints)
Returns true if there is an edge that directly connectsendpoints
(in the order, if any, specified byendpoints
). This is equivalent toedges().contains(endpoints)
.Unlike the other
EndpointPair
accepting methods, this method does not throw if the endpoints are unordered and the graph is directed; it simply returnsfalse
. This is for consistency with the behavior ofCollection#contains(Object)
(which does not generally throw if the object cannot be present in the collection), and the desire to have this method's behavior be compatible withedges().contains(endpoints)
. Since:
 27.1

edgeValue
java.util.Optional<V> edgeValue(N nodeU, N nodeV)
Returns the value of the edge that connectsnodeU
tonodeV
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsOptional.empty()
. Throws:
java.lang.IllegalArgumentException
 ifnodeU
ornodeV
is not an element of this graph Since:
 23.0 (since 20.0 with return type
V
)

edgeValue
java.util.Optional<V> edgeValue(EndpointPair<N> endpoints)
Returns the value of the edge that connectsendpoints
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsOptional.empty()
.If this graph is directed, the endpoints must be ordered.
 Throws:
java.lang.IllegalArgumentException
 if either endpoint is not an element of this graphjava.lang.IllegalArgumentException
 if the endpoints are unordered and the graph is directed Since:
 27.1

edgeValueOrDefault
@CheckForNull V edgeValueOrDefault(N nodeU, N nodeV, @CheckForNull V defaultValue)
Returns the value of the edge that connectsnodeU
tonodeV
, if one is present; otherwise, returnsdefaultValue
.In an undirected graph, this is equal to
edgeValueOrDefault(nodeV, nodeU, defaultValue)
. Throws:
java.lang.IllegalArgumentException
 ifnodeU
ornodeV
is not an element of this graph

edgeValueOrDefault
@CheckForNull V edgeValueOrDefault(EndpointPair<N> endpoints, @CheckForNull V defaultValue)
Returns the value of the edge that connectsendpoints
(in the order, if any, specified byendpoints
), if one is present; otherwise, returnsdefaultValue
.If this graph is directed, the endpoints must be ordered.
 Throws:
java.lang.IllegalArgumentException
 if either endpoint is not an element of this graphjava.lang.IllegalArgumentException
 if the endpoints are unordered and the graph is directed Since:
 27.1

equals
boolean equals(@CheckForNull java.lang.Object object)
Returnstrue
iffobject
is aValueGraph
that has the same elements and the same structural relationships as those in this graph.Thus, two value graphs A and B are equal if all of the following are true:
 A and B have equal
directedness
.  A and B have equal
node sets
.  A and B have equal
edge sets
.  The
value
of a given edge is the same in both A and B.
Graph properties besides
directedness
do not affect equality. For example, two graphs may be considered equal even if one allows selfloops and the other doesn't. Additionally, the order in which nodes or edges are added to the graph, and the order in which they are iterated over, are irrelevant.A reference implementation of this is provided by
AbstractValueGraph.equals(Object)
. Overrides:
equals
in classjava.lang.Object
 A and B have equal

hashCode
int hashCode()
Returns the hash code for this graph. The hash code of a graph is defined as the hash code of a map from each of itsedges
to the associatededge value
.A reference implementation of this is provided by
AbstractValueGraph.hashCode()
. Overrides:
hashCode
in classjava.lang.Object

