Class ImmutableGraph<N>
- java.lang.Object
-
- com.google.common.graph.AbstractGraph<N>
-
- com.google.common.graph.ImmutableGraph<N>
-
- Type Parameters:
N
- Node parameter type
- All Implemented Interfaces:
Graph<N>
- Direct Known Subclasses:
ImmutableValueGraph
@Beta public abstract class ImmutableGraph<N> extends AbstractGraph<N>
AGraph
whose elements and structural relationships will never change. Instances of this class may be obtained withcopyOf(Graph)
.See the Guava User's Guide's discussion of the
Immutable*
types for more information on the properties and guarantees provided by this class.- Since:
- 20.0
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.util.Set<N>
adjacentNodes(java.lang.Object 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).static <N> ImmutableGraph<N>
copyOf(Graph<N> graph)
Returns an immutable copy ofgraph
.static <N> ImmutableGraph<N>
copyOf(ImmutableGraph<N> graph)
Deprecated.no need to use thisint
degree(java.lang.Object node)
Returns the count ofnode
's incident edges, counting self-loops twice (equivalently, the number of times an edge touchesnode
).protected abstract Graph<N>
delegate()
java.util.Set<EndpointPair<N>>
edges()
A reasonable default implementation ofGraph.edges()
defined in terms ofGraph.nodes()
andGraph.successors(Object)
.int
inDegree(java.lang.Object 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(java.lang.Object node)
Returns the count ofnode
's outgoing edges (equal tosuccessors(node).size()
) in a directed graph.java.util.Set<N>
predecessors(java.lang.Object 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(java.lang.Object 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
edgeCount, toString
-
-
-
-
Method Detail
-
copyOf
public static <N> ImmutableGraph<N> copyOf(Graph<N> graph)
Returns an immutable copy ofgraph
.
-
copyOf
@Deprecated public static <N> ImmutableGraph<N> copyOf(ImmutableGraph<N> graph)
Deprecated.no need to use thisSimply returns its argument.
-
delegate
protected abstract Graph<N> delegate()
-
nodes
public java.util.Set<N> nodes()
Description copied from interface:Graph
Returns all nodes in this graph, in the order specified byGraph.nodeOrder()
.
-
edges
public java.util.Set<EndpointPair<N>> edges()
Description copied from class:AbstractGraph
A reasonable default implementation ofGraph.edges()
defined in terms ofGraph.nodes()
andGraph.successors(Object)
.- Specified by:
edges
in interfaceGraph<N>
- Overrides:
edges
in classAbstractGraph<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 anUnsupportedOperationException
.
-
nodeOrder
public ElementOrder<N> nodeOrder()
Description copied from interface:Graph
Returns the order of iteration for the elements ofGraph.nodes()
.
-
adjacentNodes
public java.util.Set<N> adjacentNodes(java.lang.Object node)
Description copied from interface:Graph
Returns the nodes which have an incident edge in common withnode
in this graph.
-
predecessors
public java.util.Set<N> predecessors(java.lang.Object 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(java.lang.Object 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)
.
-
degree
public int degree(java.lang.Object node)
Description copied from interface:Graph
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
adjacentNodes(node).size()
+ (1 ifnode
has an incident self-loop, 0 otherwise).If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.- Specified by:
degree
in interfaceGraph<N>
- Overrides:
degree
in classAbstractGraph<N>
-
inDegree
public int inDegree(java.lang.Object node)
Description copied from interface:Graph
Returns the count ofnode
's incoming edges (equal topredecessors(node).size()
) in a directed graph. In an undirected graph, returns theGraph.degree(Object)
.If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.- Specified by:
inDegree
in interfaceGraph<N>
- Overrides:
inDegree
in classAbstractGraph<N>
-
outDegree
public int outDegree(java.lang.Object node)
Description copied from interface:Graph
Returns the count ofnode
's outgoing edges (equal tosuccessors(node).size()
) in a directed graph. In an undirected graph, returns theGraph.degree(Object)
.If the count is greater than
Integer.MAX_VALUE
, returnsInteger.MAX_VALUE
.- Specified by:
outDegree
in interfaceGraph<N>
- Overrides:
outDegree
in classAbstractGraph<N>
-
-