Class ForwardingValueGraph<N,V>
- All Implemented Interfaces:
BaseGraph<N>,PredecessorsFunction<N>,SuccessorsFunction<N>,ValueGraph<N,V>
- Direct Known Subclasses:
Graphs.TransposedValueGraph
ValueGraph implementations to be backed by a provided delegate. This is
not currently planned to be released as a general-purpose forwarding class.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadjacentNodes(N node) Returns the nodes which have an incident edge in common withnodein this graph.booleanReturns true if this graph allows self-loops (edges that connect a node to itself).intReturns the count ofnode's incident edges, counting self-loops twice (equivalently, the number of times an edge touchesnode).(package private) abstract ValueGraph<N,V> delegate()protected longDefer toAbstractBaseGraph.edges()(based onsuccessors(Object)) for full edges() implementation.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().Returns the value of the edge that connectsnodeUtonodeV(in the order, if any, specified byendpoints), if one is present; otherwise, returnsOptional.empty().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 connectsnodeUtonodeV, if one is present; otherwise, returnsdefaultValue.booleanhasEdgeConnecting(EndpointPair<N> endpoints) Returns true if there is an edge that directly connectsendpoints(in the order, if any, specified byendpoints).booleanhasEdgeConnecting(N nodeU, N nodeV) Returns true if there is an edge that directly connectsnodeUtonodeV.Returns anElementOrderthat specifies the order of iteration for the elements ofBaseGraph.edges(),BaseGraph.adjacentNodes(Object),BaseGraph.predecessors(Object),BaseGraph.successors(Object)andBaseGraph.incidentEdges(Object).intReturns the count ofnode's incoming edges (equal topredecessors(node).size()) in a directed graph.booleanReturns 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().intReturns the count ofnode's outgoing edges (equal tosuccessors(node).size()) in a directed graph.predecessors(N node) Returns all nodes in this graph adjacent tonodewhich can be reached by traversingnode's incoming edges against the direction (if any) of the edge.successors(N node) Returns all nodes in this graph adjacent tonodewhich 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, equals, hashCode, toStringMethods inherited from class com.google.common.graph.AbstractBaseGraph
edges, incidentEdges, isOrderingCompatible, validateEndpointsMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.common.graph.ValueGraph
edges, incidentEdges
-
Constructor Details
-
ForwardingValueGraph
ForwardingValueGraph()
-
-
Method Details
-
delegate
-
nodes
Description copied from interface:ValueGraphReturns all nodes in this graph, in the order specified byValueGraph.nodeOrder(). -
edgeCount
protected long edgeCount()Defer toAbstractBaseGraph.edges()(based onsuccessors(Object)) for full edges() implementation.- Overrides:
edgeCountin classAbstractBaseGraph<N>
-
isDirected
public boolean isDirected()Description copied from interface:ValueGraphReturns true if the edges in this graph are directed. Directed edges connect asource nodeto atarget node, while undirected edges connect a pair of nodes to each other. -
allowsSelfLoops
public boolean allowsSelfLoops()Description copied from interface:ValueGraphReturns 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:ValueGraphReturns the order of iteration for the elements ofValueGraph.nodes(). -
incidentEdgeOrder
Description copied from interface:BaseGraphReturns anElementOrderthat specifies the order of iteration for the elements ofBaseGraph.edges(),BaseGraph.adjacentNodes(Object),BaseGraph.predecessors(Object),BaseGraph.successors(Object)andBaseGraph.incidentEdges(Object).- Specified by:
incidentEdgeOrderin interfaceBaseGraph<N>- Specified by:
incidentEdgeOrderin interfaceValueGraph<N,V> - Overrides:
incidentEdgeOrderin classAbstractBaseGraph<N>
-
adjacentNodes
Description copied from interface:ValueGraphReturns the nodes which have an incident edge in common withnodein this graph.This is equal to the union of
ValueGraph.predecessors(Object)andValueGraph.successors(Object). -
predecessors
Description copied from interface:ValueGraphReturns all nodes in this graph adjacent tonodewhich 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). -
successors
Description copied from interface:ValueGraphReturns all nodes in this graph adjacent tonodewhich 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
nodeby following outgoing edges". For that functionality, seeGraphs.reachableNodes(Graph, Object). -
degree
Description copied from interface:BaseGraphReturns 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
incidentEdges(node).size()+ (number of self-loops incident tonode).If the count is greater than
Integer.MAX_VALUE, returnsInteger.MAX_VALUE.- Specified by:
degreein interfaceBaseGraph<N>- Specified by:
degreein interfaceValueGraph<N,V> - Overrides:
degreein classAbstractBaseGraph<N>
-
inDegree
Description copied from interface:BaseGraphReturns the count ofnode's incoming edges (equal topredecessors(node).size()) in a directed graph. In an undirected graph, returns theBaseGraph.degree(Object).If the count is greater than
Integer.MAX_VALUE, returnsInteger.MAX_VALUE.- Specified by:
inDegreein interfaceBaseGraph<N>- Specified by:
inDegreein interfaceValueGraph<N,V> - Overrides:
inDegreein classAbstractBaseGraph<N>
-
outDegree
Description copied from interface:BaseGraphReturns the count ofnode's outgoing edges (equal tosuccessors(node).size()) in a directed graph. In an undirected graph, returns theBaseGraph.degree(Object).If the count is greater than
Integer.MAX_VALUE, returnsInteger.MAX_VALUE.- Specified by:
outDegreein interfaceBaseGraph<N>- Specified by:
outDegreein interfaceValueGraph<N,V> - Overrides:
outDegreein classAbstractBaseGraph<N>
-
hasEdgeConnecting
Description copied from interface:BaseGraphReturns true if there is an edge that directly connectsnodeUtonodeV. This is equivalent tonodes().contains(nodeU) && successors(nodeU).contains(nodeV).In an undirected graph, this is equal to
hasEdgeConnecting(nodeV, nodeU).- Specified by:
hasEdgeConnectingin interfaceBaseGraph<N>- Specified by:
hasEdgeConnectingin interfaceValueGraph<N,V> - Overrides:
hasEdgeConnectingin classAbstractBaseGraph<N>
-
hasEdgeConnecting
Description copied from interface:BaseGraphReturns 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 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).- Specified by:
hasEdgeConnectingin interfaceBaseGraph<N>- Specified by:
hasEdgeConnectingin interfaceValueGraph<N,V> - Overrides:
hasEdgeConnectingin classAbstractBaseGraph<N>
-
edgeValue
Description copied from interface:ValueGraphReturns the value of the edge that connectsnodeUtonodeV(in the order, if any, specified byendpoints), if one is present; otherwise, returnsOptional.empty().- Specified by:
edgeValuein interfaceValueGraph<N,V> - Overrides:
edgeValuein classAbstractValueGraph<N,V>
-
edgeValue
Description copied from interface:ValueGraphReturns 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.
- Specified by:
edgeValuein interfaceValueGraph<N,V> - Overrides:
edgeValuein classAbstractValueGraph<N,V>
-
edgeValueOrDefault
Description copied from interface:ValueGraphReturns the value of the edge that connectsnodeUtonodeV, if one is present; otherwise, returnsdefaultValue.In an undirected graph, this is equal to
edgeValueOrDefault(nodeV, nodeU, defaultValue). -
edgeValueOrDefault
Description copied from interface:ValueGraphReturns 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.
-