Class ConfigurableNetwork<N,E>
- java.lang.Object
-
- com.google.common.graph.AbstractNetwork<N,E>
-
- com.google.common.graph.ConfigurableNetwork<N,E>
-
- Type Parameters:
N
- Node parameter typeE
- Edge parameter type
- All Implemented Interfaces:
Network<N,E>
- Direct Known Subclasses:
ConfigurableMutableNetwork
,ImmutableNetwork
class ConfigurableNetwork<N,E> extends AbstractNetwork<N,E>
Configurable implementation ofNetwork
that supports the options supplied byNetworkBuilder
.This class maintains a map of nodes to
NetworkConnections
. This class also maintains a map of edges to reference nodes. The reference node is defined to be the edge's source node on directed graphs, and an arbitrary endpoint of the edge on undirected graphs.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
allowsParallelEdges
private boolean
allowsSelfLoops
private ElementOrder<E>
edgeOrder
protected MapIteratorCache<E,N>
edgeToReferenceNode
private boolean
isDirected
protected MapIteratorCache<N,NetworkConnections<N,E>>
nodeConnections
private ElementOrder<N>
nodeOrder
-
Constructor Summary
Constructors Constructor Description ConfigurableNetwork(NetworkBuilder<? super N,? super E> builder)
Constructs a graph with the properties specified inbuilder
.ConfigurableNetwork(NetworkBuilder<? super N,? super E> builder, java.util.Map<N,NetworkConnections<N,E>> nodeConnections, java.util.Map<E,N> edgeToReferenceNode)
Constructs a graph with the properties specified inbuilder
, initialized with the given node and edge maps.
-
Method Summary
All Methods Instance Methods Concrete 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 network.boolean
allowsParallelEdges()
Returns true if this network allows parallel edges.boolean
allowsSelfLoops()
Returns true if this network allows self-loops (edges that connect a node to itself).protected NetworkConnections<N,E>
checkedConnections(java.lang.Object node)
protected N
checkedReferenceNode(java.lang.Object edge)
protected boolean
containsEdge(java.lang.Object edge)
protected boolean
containsNode(java.lang.Object node)
ElementOrder<E>
edgeOrder()
Returns the order of iteration for the elements ofNetwork.edges()
.java.util.Set<E>
edges()
Returns all edges in this network, in the order specified byNetwork.edgeOrder()
.java.util.Set<E>
edgesConnecting(java.lang.Object nodeU, java.lang.Object nodeV)
Returns the set of edges directly connectingnodeU
tonodeV
.java.util.Set<E>
incidentEdges(java.lang.Object node)
Returns the edges whoseincident nodes
in this network includenode
.EndpointPair<N>
incidentNodes(java.lang.Object edge)
Returns the nodes which are the endpoints ofedge
in this network.java.util.Set<E>
inEdges(java.lang.Object node)
Returns all edges in this network which can be traversed in the direction (if any) of the edge to end atnode
.boolean
isDirected()
Returns true if the edges in this network are directed.ElementOrder<N>
nodeOrder()
Returns the order of iteration for the elements ofNetwork.nodes()
.java.util.Set<N>
nodes()
Returns all nodes in this network, in the order specified byNetwork.nodeOrder()
.java.util.Set<E>
outEdges(java.lang.Object node)
Returns all edges in this network which can be traversed in the direction (if any) of the edge starting fromnode
.java.util.Set<N>
predecessors(java.lang.Object node)
Returns all nodes in this network 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 network 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.AbstractNetwork
adjacentEdges, asGraph, degree, inDegree, outDegree, toString
-
-
-
-
Field Detail
-
isDirected
private final boolean isDirected
-
allowsParallelEdges
private final boolean allowsParallelEdges
-
allowsSelfLoops
private final boolean allowsSelfLoops
-
nodeOrder
private final ElementOrder<N> nodeOrder
-
edgeOrder
private final ElementOrder<E> edgeOrder
-
nodeConnections
protected final MapIteratorCache<N,NetworkConnections<N,E>> nodeConnections
-
edgeToReferenceNode
protected final MapIteratorCache<E,N> edgeToReferenceNode
-
-
Constructor Detail
-
ConfigurableNetwork
ConfigurableNetwork(NetworkBuilder<? super N,? super E> builder)
Constructs a graph with the properties specified inbuilder
.
-
ConfigurableNetwork
ConfigurableNetwork(NetworkBuilder<? super N,? super E> builder, java.util.Map<N,NetworkConnections<N,E>> nodeConnections, java.util.Map<E,N> edgeToReferenceNode)
Constructs a graph with the properties specified inbuilder
, initialized with the given node and edge maps.
-
-
Method Detail
-
nodes
public java.util.Set<N> nodes()
Description copied from interface:Network
Returns all nodes in this network, in the order specified byNetwork.nodeOrder()
.
-
edges
public java.util.Set<E> edges()
Description copied from interface:Network
Returns all edges in this network, in the order specified byNetwork.edgeOrder()
.
-
isDirected
public boolean isDirected()
Description copied from interface:Network
Returns true if the edges in this network are directed. Directed edges connect asource node
to atarget node
, while undirected edges connect a pair of nodes to each other.
-
allowsParallelEdges
public boolean allowsParallelEdges()
Description copied from interface:Network
Returns true if this network allows parallel edges. Attempting to add a parallel edge to a network that does not allow them will throw anUnsupportedOperationException
.
-
allowsSelfLoops
public boolean allowsSelfLoops()
Description copied from interface:Network
Returns true if this network allows self-loops (edges that connect a node to itself). Attempting to add a self-loop to a network that does not allow them will throw anUnsupportedOperationException
.
-
nodeOrder
public ElementOrder<N> nodeOrder()
Description copied from interface:Network
Returns the order of iteration for the elements ofNetwork.nodes()
.
-
edgeOrder
public ElementOrder<E> edgeOrder()
Description copied from interface:Network
Returns the order of iteration for the elements ofNetwork.edges()
.
-
incidentEdges
public java.util.Set<E> incidentEdges(java.lang.Object node)
Description copied from interface:Network
Returns the edges whoseincident nodes
in this network includenode
.
-
incidentNodes
public EndpointPair<N> incidentNodes(java.lang.Object edge)
Description copied from interface:Network
Returns the nodes which are the endpoints ofedge
in this network.
-
adjacentNodes
public java.util.Set<N> adjacentNodes(java.lang.Object node)
Description copied from interface:Network
Returns the nodes which have an incident edge in common withnode
in this network.
-
edgesConnecting
public java.util.Set<E> edgesConnecting(java.lang.Object nodeU, java.lang.Object nodeV)
Description copied from interface:Network
Returns the set of edges directly connectingnodeU
tonodeV
.In an undirected network, this is equal to
edgesConnecting(nodeV, nodeU)
.The resulting set of edges will be parallel (i.e. have equal
Network.incidentNodes(Object)
. If this network does notallow parallel edges
, the resulting set will contain at most one edge.
-
inEdges
public java.util.Set<E> inEdges(java.lang.Object node)
Description copied from interface:Network
Returns all edges in this network which can be traversed in the direction (if any) of the edge to end atnode
.In a directed network, an incoming edge's
EndpointPair.target()
equalsnode
.In an undirected network, this is equivalent to
Network.incidentEdges(Object)
.
-
outEdges
public java.util.Set<E> outEdges(java.lang.Object node)
Description copied from interface:Network
Returns all edges in this network which can be traversed in the direction (if any) of the edge starting fromnode
.In a directed network, an outgoing edge's
EndpointPair.source()
equalsnode
.In an undirected network, this is equivalent to
Network.incidentEdges(Object)
.
-
predecessors
public java.util.Set<N> predecessors(java.lang.Object node)
Description copied from interface:Network
Returns all nodes in this network adjacent tonode
which can be reached by traversingnode
's incoming edges against the direction (if any) of the edge.In an undirected network, this is equivalent to
Network.adjacentNodes(Object)
.
-
successors
public java.util.Set<N> successors(java.lang.Object node)
Description copied from interface:Network
Returns all nodes in this network adjacent tonode
which can be reached by traversingnode
's outgoing edges in the direction (if any) of the edge.In an undirected network, this is equivalent to
Network.adjacentNodes(Object)
.This is not the same as "all nodes reachable from
node
by following outgoing edges". For that functionality, seeGraphs.reachableNodes(Graph, Object)
.
-
checkedConnections
protected final NetworkConnections<N,E> checkedConnections(java.lang.Object node)
-
checkedReferenceNode
protected final N checkedReferenceNode(java.lang.Object edge)
-
containsNode
protected final boolean containsNode(@Nullable java.lang.Object node)
-
containsEdge
protected final boolean containsEdge(@Nullable java.lang.Object edge)
-
-