Interface BaseGraph<N>
- Type Parameters:
N- Node parameter type
- All Superinterfaces:
PredecessorsFunction<N>,SuccessorsFunction<N>
- All Known Subinterfaces:
Graph<N>,MutableGraph<N>,MutableValueGraph<N,,V> ValueGraph<N,V>
- All Known Implementing Classes:
AbstractBaseGraph,AbstractGraph,AbstractValueGraph,ForwardingGraph,ForwardingValueGraph,Graphs.TransposedGraph,Graphs.TransposedValueGraph,ImmutableGraph,ImmutableValueGraph,StandardMutableGraph,StandardMutableValueGraph,StandardValueGraph
Graph and ValueGraph.-
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).Set<EndpointPair<N>>edges()Returns all edges in this graph.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 ofedges(),adjacentNodes(Object),predecessors(Object),successors(Object)andincidentEdges(Object).Set<EndpointPair<N>>incidentEdges(N node) Returns the edges in this graph whose endpoints includenode.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 ofnodes().nodes()Returns all nodes in this graph, in the order specified bynodeOrder().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.
-
Method Details
-
nodes
Returns all nodes in this graph, in the order specified bynodeOrder(). -
edges
Set<EndpointPair<N>> edges()Returns all edges in this graph. -
isDirected
boolean isDirected()Returns 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
boolean allowsSelfLoops()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
ElementOrder<N> nodeOrder()Returns the order of iteration for the elements ofnodes(). -
incidentEdgeOrder
ElementOrder<N> incidentEdgeOrder()Returns anElementOrderthat specifies the order of iteration for the elements ofedges(),adjacentNodes(Object),predecessors(Object),successors(Object)andincidentEdges(Object).- Since:
- 29.0
-
adjacentNodes
Returns the nodes which have an incident edge in common withnodein this graph.This is equal to the union of
predecessors(Object)andsuccessors(Object).- Throws:
IllegalArgumentException- ifnodeis not an element of this graph
-
predecessors
Returns 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
adjacentNodes(Object).- Specified by:
predecessorsin interfacePredecessorsFunction<N>- Throws:
IllegalArgumentException- ifnodeis not an element of this graph
-
successors
Returns 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
adjacentNodes(Object).This is not the same as "all nodes reachable from
nodeby following outgoing edges". For that functionality, seeGraphs.reachableNodes(Graph, Object).- Specified by:
successorsin interfaceSuccessorsFunction<N>- Throws:
IllegalArgumentException- ifnodeis not an element of this graph
-
incidentEdges
Returns the edges in this graph whose endpoints includenode.This is equal to the union of incoming and outgoing edges.
- Throws:
IllegalArgumentException- ifnodeis not an element of this graph- Since:
- 24.0
-
degree
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.- Throws:
IllegalArgumentException- ifnodeis not an element of this graph
-
inDegree
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:
IllegalArgumentException- ifnodeis not an element of this graph
-
outDegree
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:
IllegalArgumentException- ifnodeis not an element of this graph
-
hasEdgeConnecting
Returns 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).- Since:
- 23.0
-
hasEdgeConnecting
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).- Since:
- 27.1
-