BaseGraph

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, ConfigurableMutableGraph, ConfigurableMutableValueGraph, ConfigurableValueGraph, ForwardingGraph, ForwardingValueGraph, Graphs.TransposedGraph, Graphs.TransposedValueGraph, ImmutableGraph, ImmutableValueGraph
```
interface BaseGraph<N>
extends SuccessorsFunction<N>, PredecessorsFunction<N>
```
A non-public interface for the methods shared between Graph and ValueGraph.

Method Summary

All Methods Instance Methods Abstract Methods
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`).
`java.util.Set<EndpointPair<N>>`	`edges()` Returns all edges in this graph.
`boolean`	`hasEdgeConnecting(N nodeU, N nodeV)` Returns true if there is an edge directly connecting `nodeU` to `nodeV`.
`java.util.Set<EndpointPair<N>>`	`incidentEdges(N node)` Returns the edges in this graph whose endpoints include `node`.
`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 `nodes()`.
`java.util.Set<N>`	`nodes()` Returns all nodes in this graph, in the order specified by `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.

- Method Detail
  - nodes
```
java.util.Set<N> nodes()
```
    Returns all nodes in this graph, in the order specified by nodeOrder().
  - edges
```
java.util.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 a source node to a target 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 an IllegalArgumentException.
  - nodeOrder
```
ElementOrder<N> nodeOrder()
```
    Returns the order of iteration for the elements of nodes().
  - adjacentNodes
```
java.util.Set<N> adjacentNodes(N node)
```
    Returns the nodes which have an incident edge in common with node in this graph.
    
    Throws:
    
    java.lang.IllegalArgumentException - if node is not an element of this graph
  - predecessors
```
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.
    In an undirected graph, this is equivalent to adjacentNodes(Object).
    
    Specified by:
    
    predecessors in interface PredecessorsFunction<N>
    
    Throws:
    
    java.lang.IllegalArgumentException - if node is not an element of this graph
  - successors
```
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.
    In an undirected graph, this is equivalent to 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).
    
    Specified by:
    
    successors in interface SuccessorsFunction<N>
    
    Throws:
    
    java.lang.IllegalArgumentException - if node is not an element of this graph
  - incidentEdges
```
java.util.Set<EndpointPair<N>> incidentEdges(N node)
```
    Returns the edges in this graph whose endpoints include node.
    
    Throws:
    
    java.lang.IllegalArgumentException - if node is not an element of this graph
    
    Since:
    
    24.0
  - degree
```
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).
    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.
    
    Throws:
    
    java.lang.IllegalArgumentException - if node is not an element of this graph
  - inDegree
```
int inDegree(N node)
```
    Returns the count of node's incoming edges (equal to predecessors(node).size()) in a directed graph. In an undirected graph, returns the degree(Object).
    If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.
    
    Throws:
    
    java.lang.IllegalArgumentException - if node is not an element of this graph
  - outDegree
```
int outDegree(N node)
```
    Returns the count of node's outgoing edges (equal to successors(node).size()) in a directed graph. In an undirected graph, returns the degree(Object).
    If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.
    
    Throws:
    
    java.lang.IllegalArgumentException - if node is not an element of this graph
  - hasEdgeConnecting
```
boolean hasEdgeConnecting(N nodeU,
                          N nodeV)
```
    Returns true if there is an edge directly connecting nodeU to nodeV. This is equivalent to nodes().contains(nodeU) && successors(nodeU).contains(nodeV).
    In an undirected graph, this is equal to hasEdgeConnecting(nodeV, nodeU).
    
    Since:
    
    23.0

Interface BaseGraph<N>

Method Summary

Method Detail

nodes

edges

isDirected

allowsSelfLoops

nodeOrder

adjacentNodes

predecessors

successors

incidentEdges

degree

inDegree

outDegree

hasEdgeConnecting