Class ForwardingGraph<N>
- java.lang.Object
-
- com.google.common.graph.AbstractBaseGraph<N>
-
- com.google.common.graph.AbstractGraph<N>
-
- com.google.common.graph.ForwardingGraph<N>
-
- All Implemented Interfaces:
BaseGraph<N>
,Graph<N>
,PredecessorsFunction<N>
,SuccessorsFunction<N>
- Direct Known Subclasses:
Graphs.TransposedGraph
,ImmutableGraph
,StandardMutableGraph
abstract class ForwardingGraph<N> extends AbstractGraph<N>
-
-
Constructor Summary
Constructors Constructor Description ForwardingGraph()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.util.Set<N>
adjacentNodes(N 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(N node)
Returns the count ofnode
's incident edges, counting self-loops twice (equivalently, the number of times an edge touchesnode
).protected abstract BaseGraph<N>
delegate()
protected long
edgeCount()
Defer toAbstractBaseGraph.edges()
(based onsuccessors(Object)
) for full edges() implementation.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
.ElementOrder<N>
incidentEdgeOrder()
Returns anElementOrder
that specifies the order of iteration for the elements ofBaseGraph.edges()
,BaseGraph.adjacentNodes(Object)
,BaseGraph.predecessors(Object)
,BaseGraph.successors(Object)
andBaseGraph.incidentEdges(Object)
.java.util.Set<EndpointPair<N>>
incidentEdges(N node)
Returns 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 ofGraph.nodes()
.java.util.Set<N>
nodes()
Returns all nodes in this graph, in the order specified byGraph.nodeOrder()
.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 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 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.AbstractGraph
equals, hashCode, toString
-
Methods inherited from class com.google.common.graph.AbstractBaseGraph
edges, isOrderingCompatible, validateEndpoints
-
-
-
-
Method Detail
-
nodes
public java.util.Set<N> nodes()
Description copied from interface:Graph
Returns all nodes in this graph, in the order specified byGraph.nodeOrder()
.
-
edgeCount
protected long edgeCount()
Defer toAbstractBaseGraph.edges()
(based onsuccessors(Object)
) for full edges() implementation.- Overrides:
edgeCount
in classAbstractBaseGraph<N>
-
isDirected
public boolean isDirected()
Description copied from interface:Graph
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:Graph
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
public ElementOrder<N> nodeOrder()
Description copied from interface:Graph
Returns the order of iteration for the elements ofGraph.nodes()
.
-
incidentEdgeOrder
public ElementOrder<N> incidentEdgeOrder()
Description copied from interface:BaseGraph
Returns anElementOrder
that specifies the order of iteration for the elements ofBaseGraph.edges()
,BaseGraph.adjacentNodes(Object)
,BaseGraph.predecessors(Object)
,BaseGraph.successors(Object)
andBaseGraph.incidentEdges(Object)
.- Specified by:
incidentEdgeOrder
in interfaceBaseGraph<N>
- Specified by:
incidentEdgeOrder
in interfaceGraph<N>
- Overrides:
incidentEdgeOrder
in classAbstractBaseGraph<N>
-
adjacentNodes
public java.util.Set<N> adjacentNodes(N node)
Description copied from interface:Graph
Returns the nodes which have an incident edge in common withnode
in this graph.This is equal to the union of
Graph.predecessors(Object)
andGraph.successors(Object)
.
-
predecessors
public java.util.Set<N> predecessors(N node)
Description copied from interface:Graph
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
Graph.adjacentNodes(Object)
.
-
successors
public java.util.Set<N> successors(N node)
Description copied from interface:Graph
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
Graph.adjacentNodes(Object)
.This is not the same as "all nodes reachable from
node
by following outgoing edges". For that functionality, seeGraphs.reachableNodes(Graph, Object)
.
-
incidentEdges
public java.util.Set<EndpointPair<N>> incidentEdges(N node)
Description copied from interface:BaseGraph
Returns the edges in this graph whose endpoints includenode
.This is equal to the union of incoming and outgoing edges.
- Specified by:
incidentEdges
in interfaceBaseGraph<N>
- Specified by:
incidentEdges
in interfaceGraph<N>
- Overrides:
incidentEdges
in classAbstractBaseGraph<N>
-
degree
public int degree(N node)
Description copied from interface:BaseGraph
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
incidentEdges(node).size()
+ (number of self-loops incident tonode
).If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.
-
inDegree
public int inDegree(N node)
Description copied from interface:BaseGraph
Returns 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
.
-
outDegree
public int outDegree(N node)
Description copied from interface:BaseGraph
Returns 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
.
-
hasEdgeConnecting
public boolean hasEdgeConnecting(N nodeU, N nodeV)
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 interfaceGraph<N>
- Overrides:
hasEdgeConnecting
in classAbstractBaseGraph<N>
-
hasEdgeConnecting
public boolean hasEdgeConnecting(EndpointPair<N> endpoints)
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 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:
hasEdgeConnecting
in interfaceBaseGraph<N>
- Specified by:
hasEdgeConnecting
in interfaceGraph<N>
- Overrides:
hasEdgeConnecting
in classAbstractBaseGraph<N>
-
-