abstract class ForwardingValueGraph<N,V> extends AbstractValueGraph<N,V>
ValueGraph implementations to be backed by a provided delegate. This is
not currently planned to be released as a general-purpose forwarding class.| Constructor and Description |
|---|
ForwardingValueGraph() |
| Modifier and Type | Method and Description |
|---|---|
java.util.Set<N> |
adjacentNodes(N node)
Returns the nodes which have an incident edge in common with
node 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 of
node's incident edges, counting self-loops twice (equivalently,
the number of times an edge touches node). |
(package private) abstract ValueGraph<N,V> |
delegate() |
protected long |
edgeCount()
Defer to
AbstractBaseGraph.edges() (based on successors(Object)) for full
edges() implementation. |
java.util.Optional<V> |
edgeValue(EndpointPair<N> endpoints)
Returns the value of the edge that connects
endpoints (in the order, if any, specified
by endpoints), if one is present; otherwise, returns Optional.empty(). |
java.util.Optional<V> |
edgeValue(N nodeU,
N nodeV)
Returns the value of the edge that connects
nodeU to nodeV (in the order, if
any, specified by endpoints), if one is present; otherwise, returns Optional.empty(). |
V |
edgeValueOrDefault(EndpointPair<N> endpoints,
V defaultValue)
Returns the value of the edge that connects
endpoints (in the order, if any, specified
by endpoints), if one is present; otherwise, returns defaultValue. |
V |
edgeValueOrDefault(N nodeU,
N nodeV,
V defaultValue)
Returns the value of the edge that connects
nodeU to nodeV, if one is present;
otherwise, returns defaultValue. |
boolean |
hasEdgeConnecting(EndpointPair<N> endpoints)
Returns true if there is an edge that directly connects
endpoints (in the order, if
any, specified by endpoints). |
boolean |
hasEdgeConnecting(N nodeU,
N nodeV)
Returns true if there is an edge that directly connects
nodeU to nodeV. |
ElementOrder<N> |
incidentEdgeOrder()
Returns an
ElementOrder that specifies the order of iteration for the elements of
BaseGraph.edges(), BaseGraph.adjacentNodes(Object), BaseGraph.predecessors(Object), BaseGraph.successors(Object) and BaseGraph.incidentEdges(Object). |
int |
inDegree(N node)
Returns the count of
node's incoming edges (equal to predecessors(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 of
ValueGraph.nodes(). |
java.util.Set<N> |
nodes()
Returns all nodes in this graph, in the order specified by
ValueGraph.nodeOrder(). |
int |
outDegree(N node)
Returns the count of
node's outgoing edges (equal to successors(node).size())
in a directed graph. |
java.util.Set<N> |
predecessors(N node)
Returns all nodes in this graph adjacent to
node which can be reached by traversing
node'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 to
node which can be reached by traversing
node's outgoing edges in the direction (if any) of the edge. |
asGraph, equals, hashCode, toStringedges, incidentEdges, isOrderingCompatible, validateEndpointsclone, finalize, getClass, notify, notifyAll, wait, wait, waitedges, incidentEdgesabstract ValueGraph<N,V> delegate()
public java.util.Set<N> nodes()
ValueGraphValueGraph.nodeOrder().protected long edgeCount()
AbstractBaseGraph.edges() (based on successors(Object)) for full
edges() implementation.edgeCount in class AbstractBaseGraph<N>public boolean isDirected()
ValueGraphsource node to a target node, while
undirected edges connect a pair of nodes to each other.public boolean allowsSelfLoops()
ValueGraphIllegalArgumentException.public ElementOrder<N> nodeOrder()
ValueGraphValueGraph.nodes().public ElementOrder<N> incidentEdgeOrder()
BaseGraphElementOrder that specifies the order of iteration for the elements of
BaseGraph.edges(), BaseGraph.adjacentNodes(Object), BaseGraph.predecessors(Object), BaseGraph.successors(Object) and BaseGraph.incidentEdges(Object).incidentEdgeOrder in interface BaseGraph<N>incidentEdgeOrder in interface ValueGraph<N,V>incidentEdgeOrder in class AbstractBaseGraph<N>public java.util.Set<N> adjacentNodes(N node)
ValueGraphnode in this graph.
This is equal to the union of ValueGraph.predecessors(Object) and ValueGraph.successors(Object).
public java.util.Set<N> predecessors(N node)
ValueGraphnode which can be reached by traversing
node's incoming edges against the direction (if any) of the edge.
In an undirected graph, this is equivalent to ValueGraph.adjacentNodes(Object).
public java.util.Set<N> successors(N node)
ValueGraphnode which can be reached by traversing
node'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, see Graphs.reachableNodes(Graph, Object).
public int degree(N node)
BaseGraphnode's incident edges, counting self-loops twice (equivalently,
the number of times an edge touches node).
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 to node).
If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.
degree in interface BaseGraph<N>degree in interface ValueGraph<N,V>degree in class AbstractBaseGraph<N>public int inDegree(N node)
BaseGraphnode's incoming edges (equal to predecessors(node).size())
in a directed graph. In an undirected graph, returns the BaseGraph.degree(Object).
If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.
inDegree in interface BaseGraph<N>inDegree in interface ValueGraph<N,V>inDegree in class AbstractBaseGraph<N>public int outDegree(N node)
BaseGraphnode's outgoing edges (equal to successors(node).size())
in a directed graph. In an undirected graph, returns the BaseGraph.degree(Object).
If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.
outDegree in interface BaseGraph<N>outDegree in interface ValueGraph<N,V>outDegree in class AbstractBaseGraph<N>public boolean hasEdgeConnecting(N nodeU, N nodeV)
BaseGraphnodeU to nodeV. This is
equivalent to nodes().contains(nodeU) && successors(nodeU).contains(nodeV).
In an undirected graph, this is equal to hasEdgeConnecting(nodeV, nodeU).
hasEdgeConnecting in interface BaseGraph<N>hasEdgeConnecting in interface ValueGraph<N,V>hasEdgeConnecting in class AbstractBaseGraph<N>public boolean hasEdgeConnecting(EndpointPair<N> endpoints)
BaseGraphendpoints (in the order, if
any, specified by endpoints). This is equivalent to edges().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 of
Collection#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 with
edges().contains(endpoints).
hasEdgeConnecting in interface BaseGraph<N>hasEdgeConnecting in interface ValueGraph<N,V>hasEdgeConnecting in class AbstractBaseGraph<N>public java.util.Optional<V> edgeValue(N nodeU, N nodeV)
ValueGraphnodeU to nodeV (in the order, if
any, specified by endpoints), if one is present; otherwise, returns Optional.empty().edgeValue in interface ValueGraph<N,V>edgeValue in class AbstractValueGraph<N,V>public java.util.Optional<V> edgeValue(EndpointPair<N> endpoints)
ValueGraphendpoints (in the order, if any, specified
by endpoints), if one is present; otherwise, returns Optional.empty().
If this graph is directed, the endpoints must be ordered.
edgeValue in interface ValueGraph<N,V>edgeValue in class AbstractValueGraph<N,V>@CheckForNull public V edgeValueOrDefault(N nodeU, N nodeV, @CheckForNull V defaultValue)
ValueGraphnodeU to nodeV, if one is present;
otherwise, returns defaultValue.
In an undirected graph, this is equal to edgeValueOrDefault(nodeV, nodeU,
defaultValue).
@CheckForNull public V edgeValueOrDefault(EndpointPair<N> endpoints, @CheckForNull V defaultValue)
ValueGraphendpoints (in the order, if any, specified
by endpoints), if one is present; otherwise, returns defaultValue.
If this graph is directed, the endpoints must be ordered.