N
 Node parameter type@Beta public abstract class ImmutableGraph<N> extends AbstractGraph<N>
Graph
whose elements and structural relationships will never change. Instances of this
class may be obtained with copyOf(Graph)
.
This class generally provides all of the same guarantees as ImmutableCollection
(despite not extending ImmutableCollection
itself), including guaranteed threadsafety.
Modifier and Type  Method and Description 

Set<N> 
adjacentNodes(Object node)
Returns the nodes which have an incident edge in common with
node in this graph. 
boolean 
allowsSelfLoops()
Returns true if this graph allows selfloops (edges that connect a node to itself).

static <N> ImmutableGraph<N> 
copyOf(Graph<N> graph)
Returns an immutable copy of
graph . 
static <N> ImmutableGraph<N> 
copyOf(ImmutableGraph<N> graph)
Deprecated.
no need to use this

int 
degree(Object node)
Returns the count of
node 's incident edges, counting selfloops twice (equivalently,
the number of times an edge touches node ). 
protected abstract Graph<N> 
delegate() 
Set<EndpointPair<N>> 
edges()
A reasonable default implementation of
Graph.edges() defined in terms of Graph.nodes() and Graph.successors(Object) . 
int 
inDegree(Object 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
Graph.nodes() . 
Set<N> 
nodes()
Returns all nodes in this graph, in the order specified by
Graph.nodeOrder() . 
int 
outDegree(Object node)
Returns the count of
node 's outgoing edges (equal to successors(node).size() )
in a directed graph. 
Set<N> 
predecessors(Object 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. 
Set<N> 
successors(Object 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. 
edgeCount, toString
public static <N> ImmutableGraph<N> copyOf(Graph<N> graph)
graph
.@Deprecated public static <N> ImmutableGraph<N> copyOf(ImmutableGraph<N> graph)
public Set<N> nodes()
Graph
Graph.nodeOrder()
.public Set<EndpointPair<N>> edges()
AbstractGraph
Graph.edges()
defined in terms of Graph.nodes()
and Graph.successors(Object)
.edges
in interface Graph<N>
edges
in class AbstractGraph<N>
public boolean isDirected()
Graph
source node
to a target node
, while
undirected edges connect a pair of nodes to each other.public boolean allowsSelfLoops()
Graph
UnsupportedOperationException
.public ElementOrder<N> nodeOrder()
Graph
Graph.nodes()
.public Set<N> adjacentNodes(Object node)
Graph
node
in this graph.public Set<N> predecessors(Object node)
Graph
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 Graph.adjacentNodes(Object)
.
public Set<N> successors(Object node)
Graph
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 Graph.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(Object node)
Graph
node
's incident edges, counting selfloops 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 adjacentNodes(node).size()
+ (1 if node
has an incident selfloop, 0 otherwise).
If the count is greater than Integer.MAX_VALUE
, returns Integer.MAX_VALUE
.
degree
in interface Graph<N>
degree
in class AbstractGraph<N>
public int inDegree(Object node)
Graph
node
's incoming edges (equal to predecessors(node).size()
)
in a directed graph. In an undirected graph, returns the Graph.degree(Object)
.
If the count is greater than Integer.MAX_VALUE
, returns Integer.MAX_VALUE
.
inDegree
in interface Graph<N>
inDegree
in class AbstractGraph<N>
public int outDegree(Object node)
Graph
node
's outgoing edges (equal to successors(node).size()
)
in a directed graph. In an undirected graph, returns the Graph.degree(Object)
.
If the count is greater than Integer.MAX_VALUE
, returns Integer.MAX_VALUE
.
outDegree
in interface Graph<N>
outDegree
in class AbstractGraph<N>
Copyright © 20102016. All Rights Reserved.