Package com.google.common.graph
Class ImmutableValueGraph<N,V>
- java.lang.Object
-
- com.google.common.graph.AbstractValueGraph<N,V>
-
- com.google.common.graph.ImmutableValueGraph<N,V>
-
- Type Parameters:
N
- Node parameter typeV
- Value parameter type
- All Implemented Interfaces:
PredecessorsFunction<N>
,SuccessorsFunction<N>
,ValueGraph<N,V>
@Beta public final class ImmutableValueGraph<N,V> extends AbstractValueGraph<N,V>
AValueGraph
whose elements and structural relationships will never change. Instances of this class may be obtained withcopyOf(ValueGraph)
.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
- Author:
- James Sexton
-
-
Field Summary
Fields Modifier and Type Field Description protected long
edgeCount
protected com.google.common.graph.MapIteratorCache<N,com.google.common.graph.GraphConnections<N,V>>
nodeConnections
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.util.Set<N>
adjacentNodes(N 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).ImmutableGraph<N>
asGraph()
Returns a live view of this graph as aGraph
.protected com.google.common.graph.GraphConnections<N,V>
checkedConnections(N node)
protected boolean
containsNode(N node)
static <N,V>
ImmutableValueGraph<N,V>copyOf(ImmutableValueGraph<N,V> graph)
Deprecated.no need to use thisstatic <N,V>
ImmutableValueGraph<N,V>copyOf(ValueGraph<N,V> graph)
Returns an immutable copy ofgraph
.int
degree(N node)
protected long
edgeCount()
Returns the number of edges in this graph; used to calculate the size ofedges()
.java.util.Set<EndpointPair<N>>
edges()
An implementation ofBaseGraph.edges()
defined in terms ofnodes()
andSuccessorsFunction.successors(Object)
.V
edgeValueOrDefault(N nodeU, N nodeV, V defaultValue)
Returns the value of the edge connectingnodeU
tonodeV
, if one is present; otherwise, returnsdefaultValue
.boolean
hasEdgeConnecting(N nodeU, N nodeV)
Returns true if there is an edge directly connectingnodeU
tonodeV
.java.util.Set<EndpointPair<N>>
incidentEdges(N node)
int
inDegree(N node)
boolean
isDirected()
Returns true if the edges in this graph are directed.ElementOrder<N>
nodeOrder()
Returns the order of iteration for the elements ofValueGraph.nodes()
.java.util.Set<N>
nodes()
Returns all nodes in this graph, in the order specified byValueGraph.nodeOrder()
.int
outDegree(N node)
java.util.Set<N>
predecessors(N 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(N 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.AbstractValueGraph
edgeValue, equals, hashCode, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.common.graph.ValueGraph
degree, edges, incidentEdges, inDegree, outDegree
-
-
-
-
Method Detail
-
copyOf
public static <N,V> ImmutableValueGraph<N,V> copyOf(ValueGraph<N,V> graph)
Returns an immutable copy ofgraph
.
-
copyOf
@Deprecated public static <N,V> ImmutableValueGraph<N,V> copyOf(ImmutableValueGraph<N,V> graph)
Deprecated.no need to use thisSimply returns its argument.
-
asGraph
public ImmutableGraph<N> asGraph()
Description copied from interface:ValueGraph
Returns a live view of this graph as aGraph
. The resultingGraph
will have an edge connecting node A to node B if thisValueGraph
has an edge connecting A to B.- Specified by:
asGraph
in interfaceValueGraph<N,V>
- Overrides:
asGraph
in classAbstractValueGraph<N,V>
-
nodes
public java.util.Set<N> nodes()
Description copied from interface:ValueGraph
Returns all nodes in this graph, in the order specified byValueGraph.nodeOrder()
.
-
isDirected
public boolean isDirected()
Description copied from interface:ValueGraph
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:ValueGraph
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
public ElementOrder<N> nodeOrder()
Description copied from interface:ValueGraph
Returns the order of iteration for the elements ofValueGraph.nodes()
.
-
adjacentNodes
public java.util.Set<N> adjacentNodes(N node)
Description copied from interface:ValueGraph
Returns the nodes which have an incident edge in common withnode
in this graph.
-
predecessors
public java.util.Set<N> predecessors(N node)
Description copied from interface:ValueGraph
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
ValueGraph.adjacentNodes(Object)
.
-
successors
public java.util.Set<N> successors(N node)
Description copied from interface:ValueGraph
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
ValueGraph.adjacentNodes(Object)
.This is not the same as "all nodes reachable from
node
by following outgoing edges". For that functionality, seeGraphs.reachableNodes(Graph, Object)
.
-
hasEdgeConnecting
public boolean hasEdgeConnecting(N nodeU, N nodeV)
Description copied from interface:ValueGraph
Returns true if there is an edge directly connectingnodeU
tonodeV
. This is equivalent tonodes().contains(nodeU) && successors(nodeU).contains(nodeV)
.In an undirected graph, this is equal to
hasEdgeConnecting(nodeV, nodeU)
.- Specified by:
hasEdgeConnecting
in interfaceValueGraph<N,V>
-
edgeValueOrDefault
public V edgeValueOrDefault(N nodeU, N nodeV, V defaultValue)
Description copied from interface:ValueGraph
Returns the value of the edge connectingnodeU
tonodeV
, if one is present; otherwise, returnsdefaultValue
.In an undirected graph, this is equal to
edgeValueOrDefault(nodeV, nodeU, defaultValue)
.
-
edgeCount
protected long edgeCount()
Returns the number of edges in this graph; used to calculate the size ofedges()
. This implementation requires O(|N|) time. Classes extending this one may manually keep track of the number of edges as the graph is updated, and override this method for better performance.
-
checkedConnections
protected final com.google.common.graph.GraphConnections<N,V> checkedConnections(N node)
-
containsNode
protected final boolean containsNode(N node)
-
edges
public java.util.Set<EndpointPair<N>> edges()
An implementation ofBaseGraph.edges()
defined in terms ofnodes()
andSuccessorsFunction.successors(Object)
.
-
incidentEdges
public java.util.Set<EndpointPair<N>> incidentEdges(N node)
-
degree
public int degree(N node)
-
inDegree
public int inDegree(N node)
-
outDegree
public int outDegree(N node)
-
-