Class StandardValueGraph<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:
ImmutableValueGraph,StandardMutableValueGraph
ValueGraph that supports the options supplied by AbstractGraphBuilder.
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
FieldsModifier and TypeFieldDescriptionprivate final boolean(package private) longprivate final boolean(package private) final MapIteratorCache<N,GraphConnections<N, V>> private final ElementOrder<N> -
Constructor Summary
ConstructorsConstructorDescriptionStandardValueGraph(AbstractGraphBuilder<? super N> builder) Constructs a graph with the properties specified inbuilder.StandardValueGraph(AbstractGraphBuilder<? super N> builder, Map<N, GraphConnections<N, V>> nodeConnections, long edgeCount) Constructs a graph with the properties specified inbuilder, initialized with the given node map. -
Method Summary
Modifier and TypeMethodDescriptionadjacentNodes(N node) Returns the nodes which have an incident edge in common withnodein this graph.booleanReturns true if this graph allows self-loops (edges that connect a node to itself).private final GraphConnections<N,V> checkedConnections(N node) (package private) final booleancontainsNode(N node) protected longReturns the number of edges in this graph; used to calculate the size ofGraph.edges().edgeValueOrDefault(EndpointPair<N> endpoints, V defaultValue) Returns the value of the edge that connectsendpoints(in the order, if any, specified byendpoints), if one is present; otherwise, returnsdefaultValue.edgeValueOrDefault(N nodeU, N nodeV, V defaultValue) Returns the value of the edge that connectsnodeUtonodeV, if one is present; otherwise, returnsdefaultValue.private final VedgeValueOrDefaultInternal(N nodeU, N nodeV, V defaultValue) booleanhasEdgeConnecting(EndpointPair<N> endpoints) Returns true if there is an edge that directly connectsendpoints(in the order, if any, specified byendpoints).booleanhasEdgeConnecting(N nodeU, N nodeV) Returns true if there is an edge that directly connectsnodeUtonodeV.private final booleanhasEdgeConnectingInternal(N nodeU, N nodeV) Set<EndpointPair<N>>incidentEdges(N node) Returns the edges in this graph whose endpoints includenode.booleanReturns true if the edges in this graph are directed.Returns the order of iteration for the elements ofValueGraph.nodes().nodes()Returns all nodes in this graph, in the order specified byValueGraph.nodeOrder().predecessors(N node) Returns all nodes in this graph adjacent tonodewhich can be reached by traversingnode's incoming edges against the direction (if any) of the edge.successors(N node) Returns all nodes in this graph adjacent tonodewhich 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, edgeValue, equals, hashCode, toStringMethods inherited from class com.google.common.graph.AbstractBaseGraph
degree, edges, incidentEdgeOrder, inDegree, isOrderingCompatible, outDegree, validateEndpointsMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.common.graph.ValueGraph
degree, edges, incidentEdgeOrder, inDegree, outDegree
-
Field Details
-
isDirected
private final boolean isDirected -
allowsSelfLoops
private final boolean allowsSelfLoops -
nodeOrder
-
nodeConnections
-
edgeCount
long edgeCount
-
-
Constructor Details
-
StandardValueGraph
StandardValueGraph(AbstractGraphBuilder<? super N> builder) Constructs a graph with the properties specified inbuilder. -
StandardValueGraph
StandardValueGraph(AbstractGraphBuilder<? super N> builder, Map<N, GraphConnections<N, V>> nodeConnections, long edgeCount) Constructs a graph with the properties specified inbuilder, initialized with the given node map.
-
-
Method Details
-
nodes
Description copied from interface:ValueGraphReturns all nodes in this graph, in the order specified byValueGraph.nodeOrder(). -
isDirected
public boolean isDirected()Description copied from interface:ValueGraphReturns true if the edges in this graph are directed. Directed edges connect asource nodeto atarget node, while undirected edges connect a pair of nodes to each other. -
allowsSelfLoops
public boolean allowsSelfLoops()Description copied from interface:ValueGraphReturns 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
Description copied from interface:ValueGraphReturns the order of iteration for the elements ofValueGraph.nodes(). -
adjacentNodes
Description copied from interface:ValueGraphReturns the nodes which have an incident edge in common withnodein this graph.This is equal to the union of
ValueGraph.predecessors(Object)andValueGraph.successors(Object). -
predecessors
Description copied from interface:ValueGraphReturns all nodes in this graph adjacent tonodewhich 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
Description copied from interface:ValueGraphReturns all nodes in this graph adjacent tonodewhich 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
nodeby following outgoing edges". For that functionality, seeGraphs.reachableNodes(Graph, Object). -
incidentEdges
Description copied from interface:BaseGraphReturns the edges in this graph whose endpoints includenode.This is equal to the union of incoming and outgoing edges.
- Specified by:
incidentEdgesin interfaceBaseGraph<N>- Specified by:
incidentEdgesin interfaceValueGraph<N,V> - Overrides:
incidentEdgesin classAbstractBaseGraph<N>
-
hasEdgeConnecting
Description copied from interface:BaseGraphReturns true if there is an edge that directly connectsnodeUtonodeV. This is equivalent tonodes().contains(nodeU) && successors(nodeU).contains(nodeV).In an undirected graph, this is equal to
hasEdgeConnecting(nodeV, nodeU).- Specified by:
hasEdgeConnectingin interfaceBaseGraph<N>- Specified by:
hasEdgeConnectingin interfaceValueGraph<N,V> - Overrides:
hasEdgeConnectingin classAbstractBaseGraph<N>
-
hasEdgeConnecting
Description copied from interface:BaseGraphReturns true if there is an edge that directly connectsendpoints(in the order, if any, specified byendpoints). This is equivalent toedges().contains(endpoints).Unlike the other
EndpointPair-accepting methods, this method does not throw if the endpoints are unordered; it simply returns false. This is for consistency with the behavior ofCollection#contains(Object)(which does not generally throw if the object cannot be present in the collection), and the desire to have this method's behavior be compatible withedges().contains(endpoints).- Specified by:
hasEdgeConnectingin interfaceBaseGraph<N>- Specified by:
hasEdgeConnectingin interfaceValueGraph<N,V> - Overrides:
hasEdgeConnectingin classAbstractBaseGraph<N>
-
edgeValueOrDefault
Description copied from interface:ValueGraphReturns the value of the edge that connectsnodeUtonodeV, if one is present; otherwise, returnsdefaultValue.In an undirected graph, this is equal to
edgeValueOrDefault(nodeV, nodeU, defaultValue). -
edgeValueOrDefault
Description copied from interface:ValueGraphReturns the value of the edge that connectsendpoints(in the order, if any, specified byendpoints), if one is present; otherwise, returnsdefaultValue.If this graph is directed, the endpoints must be ordered.
-
edgeCount
protected long edgeCount()Description copied from class:AbstractBaseGraphReturns the number of edges in this graph; used to calculate the size ofGraph.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:
edgeCountin classAbstractBaseGraph<N>
-
checkedConnections
-
containsNode
-
hasEdgeConnectingInternal
-
edgeValueOrDefaultInternal
-