Class ConfigurableValueGraph<N,V>
- java.lang.Object
-
- com.google.common.graph.AbstractBaseGraph<N>
-
- com.google.common.graph.AbstractValueGraph<N,V>
-
- com.google.common.graph.ConfigurableValueGraph<N,V>
-
- Type Parameters:
N
- Node parameter typeV
- Value parameter type
- All Implemented Interfaces:
BaseGraph<N>
,PredecessorsFunction<N>
,SuccessorsFunction<N>
,ValueGraph<N,V>
- Direct Known Subclasses:
ConfigurableMutableValueGraph
,ImmutableValueGraph
class ConfigurableValueGraph<N,V> extends AbstractValueGraph<N,V>
Configurable implementation ofValueGraph
that supports the options supplied byAbstractGraphBuilder
.This class maintains a map of nodes to
GraphConnections
.Collection-returning accessors return unmodifiable views: the view returned will reflect changes to the graph (if the graph is mutable) but may not be modified by the user.
The time complexity of all collection-returning accessors is O(1), since views are returned.
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowsSelfLoops
protected long
edgeCount
private boolean
isDirected
protected MapIteratorCache<N,GraphConnections<N,V>>
nodeConnections
private ElementOrder<N>
nodeOrder
-
Constructor Summary
Constructors Constructor Description ConfigurableValueGraph(AbstractGraphBuilder<? super N> builder)
Constructs a graph with the properties specified inbuilder
.ConfigurableValueGraph(AbstractGraphBuilder<? super N> builder, java.util.Map<N,GraphConnections<N,V>> nodeConnections, long edgeCount)
Constructs a graph with the properties specified inbuilder
, initialized with the given node map.
-
Method Summary
All Methods Instance Methods Concrete 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).protected GraphConnections<N,V>
checkedConnections(N node)
protected boolean
containsNode(N node)
protected long
edgeCount()
Returns the number of edges in this graph; used to calculate the size ofAbstractBaseGraph.edges()
.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
.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()
.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
asGraph, edgeValue, equals, hashCode, toString
-
Methods inherited from class com.google.common.graph.AbstractBaseGraph
degree, edges, incidentEdges, inDegree, outDegree
-
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
-
-
-
-
Field Detail
-
isDirected
private final boolean isDirected
-
allowsSelfLoops
private final boolean allowsSelfLoops
-
nodeOrder
private final ElementOrder<N> nodeOrder
-
nodeConnections
protected final MapIteratorCache<N,GraphConnections<N,V>> nodeConnections
-
edgeCount
protected long edgeCount
-
-
Constructor Detail
-
ConfigurableValueGraph
ConfigurableValueGraph(AbstractGraphBuilder<? super N> builder)
Constructs a graph with the properties specified inbuilder
.
-
ConfigurableValueGraph
ConfigurableValueGraph(AbstractGraphBuilder<? super N> builder, java.util.Map<N,GraphConnections<N,V>> nodeConnections, long edgeCount)
Constructs a graph with the properties specified inbuilder
, initialized with the given node map.
-
-
Method Detail
-
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:BaseGraph
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 interfaceBaseGraph<N>
- Specified by:
hasEdgeConnecting
in interfaceValueGraph<N,V>
- Overrides:
hasEdgeConnecting
in classAbstractBaseGraph<N>
-
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()
Description copied from class:AbstractBaseGraph
Returns the number of edges in this graph; used to calculate the size ofAbstractBaseGraph.edges()
. 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.- Overrides:
edgeCount
in classAbstractBaseGraph<N>
-
checkedConnections
protected final GraphConnections<N,V> checkedConnections(N node)
-
containsNode
protected final boolean containsNode(N node)
-
-