Class StandardValueGraph<N,V>
- Type Parameters:
N
- Node parameter typeV
- Value parameter type
- All Implemented Interfaces:
BaseGraph<N>
,PredecessorsFunction<N>
,SuccessorsFunction<N>
,ValueGraph<N,
V>
- Direct Known Subclasses:
ImmutableValueGraph
,StandardMutableValueGraph
ValueGraph
that supports the options supplied by AbstractGraphBuilder
.
This class maintains a map of nodes to GraphConnections
.
Collection-returning accessors return unmodifiable views: the view returned will reflect changes to the graph (if the graph is mutable) but may not be modified by the user.
The time complexity of all collection-returning accessors is O(1), since views are returned.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
(package private) long
private final boolean
(package private) final MapIteratorCache
<N, GraphConnections<N, V>> private final ElementOrder
<N> -
Constructor Summary
ConstructorsConstructorDescriptionStandardValueGraph
(AbstractGraphBuilder<? super N> builder) Constructs a graph with the properties specified inbuilder
.StandardValueGraph
(AbstractGraphBuilder<? super N> builder, Map<N, GraphConnections<N, V>> nodeConnections, long edgeCount) Constructs a graph with the properties specified inbuilder
, initialized with the given node map. -
Method Summary
Modifier and TypeMethodDescriptionadjacentNodes
(N node) Returns a live view of the nodes which have an incident edge in common withnode
in this graph.boolean
Returns true if this graph allows self-loops (edges that connect a node to itself).private final GraphConnections
<N, V> checkedConnections
(N node) (package private) final boolean
containsNode
(N node) protected long
Returns the number of edges in this graph; used to calculate the size ofGraph.edges()
.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
.edgeValueOrDefault
(N nodeU, N nodeV, V defaultValue) Returns the value of the edge that connectsnodeU
tonodeV
, if one is present; otherwise, returnsdefaultValue
.private final V
edgeValueOrDefaultInternal
(N nodeU, N nodeV, V defaultValue) 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
.private final boolean
hasEdgeConnectingInternal
(N nodeU, N nodeV) Set
<EndpointPair<N>> incidentEdges
(N node) Returns a live view of the edges in this graph whose endpoints includenode
.boolean
Returns true if the edges in this graph are directed.Returns the order of iteration for the elements ofValueGraph.nodes()
.nodes()
Returns all nodes in this graph, in the order specified byValueGraph.nodeOrder()
.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.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.Methods inherited from class com.google.common.graph.AbstractValueGraph
asGraph, edgeValue, edgeValue, equals, hashCode, toString
Methods inherited from class com.google.common.graph.AbstractBaseGraph
degree, edges, incidentEdgeOrder, inDegree, isOrderingCompatible, nodeInvalidatableSet, nodePairInvalidatableSet, outDegree, validateEndpoints
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.common.graph.ValueGraph
degree, edges, incidentEdgeOrder, inDegree, outDegree
-
Field Details
-
isDirected
private final boolean isDirected -
allowsSelfLoops
private final boolean allowsSelfLoops -
nodeOrder
-
nodeConnections
-
edgeCount
long edgeCount
-
-
Constructor Details
-
StandardValueGraph
StandardValueGraph(AbstractGraphBuilder<? super N> builder) Constructs a graph with the properties specified inbuilder
. -
StandardValueGraph
StandardValueGraph(AbstractGraphBuilder<? super N> builder, Map<N, GraphConnections<N, V>> nodeConnections, long edgeCount) Constructs a graph with the properties specified inbuilder
, initialized with the given node map.
-
-
Method Details
-
nodes
Description copied from interface:ValueGraph
Returns all nodes in this graph, in the order specified byValueGraph.nodeOrder()
. -
isDirected
public boolean isDirected()Description copied from interface:ValueGraph
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
public boolean allowsSelfLoops()Description copied from interface:ValueGraph
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 anIllegalArgumentException
. -
nodeOrder
Description copied from interface:ValueGraph
Returns the order of iteration for the elements ofValueGraph.nodes()
. -
adjacentNodes
Description copied from interface:ValueGraph
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
ValueGraph.predecessors(Object)
andValueGraph.successors(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 re-added to the graph after having been removed,view
's behavior is undefined
-
predecessors
Description copied from interface:ValueGraph
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
ValueGraph.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. -
successors
Description copied from interface:ValueGraph
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
ValueGraph.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 re-added to the graph after having been removed,view
's behavior is undefined
-
incidentEdges
Description copied from interface:BaseGraph
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 re-added to the graph after having been removed,view
's behavior is undefined
- Specified by:
incidentEdges
in interfaceBaseGraph<N>
- Specified by:
incidentEdges
in interfaceValueGraph<N,
V> - Overrides:
incidentEdges
in classAbstractBaseGraph<N>
-
hasEdgeConnecting
Description copied from interface:BaseGraph
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)
.- Specified by:
hasEdgeConnecting
in interfaceBaseGraph<N>
- Specified by:
hasEdgeConnecting
in interfaceValueGraph<N,
V> - Overrides:
hasEdgeConnecting
in classAbstractBaseGraph<N>
-
hasEdgeConnecting
Description copied from interface:BaseGraph
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; it simply returns false. This is for consistency with the behavior ofinvalid reference
Collection#contains(Object)
edges().contains(endpoints)
.- Specified by:
hasEdgeConnecting
in interfaceBaseGraph<N>
- Specified by:
hasEdgeConnecting
in interfaceValueGraph<N,
V> - Overrides:
hasEdgeConnecting
in classAbstractBaseGraph<N>
-
edgeValueOrDefault
Description copied from interface:ValueGraph
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)
. -
edgeValueOrDefault
Description copied from interface:ValueGraph
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.
-
edgeCount
protected long edgeCount()Description copied from class:AbstractBaseGraph
Returns the number of edges in this graph; used to calculate the size ofGraph.edges()
. This implementation requires O(|N|) time. Classes extending this one may manually keep track of the number of edges as the graph is updated, and override this method for better performance.- Overrides:
edgeCount
in classAbstractBaseGraph<N>
-
checkedConnections
-
containsNode
-
hasEdgeConnectingInternal
-
edgeValueOrDefaultInternal
-