Class StandardNetwork<N,E>

java.lang.Object
com.google.common.graph.AbstractNetwork<N,E>
com.google.common.graph.StandardNetwork<N,E>
Type Parameters:
N - Node parameter type
E - Edge parameter type
All Implemented Interfaces:
Network<N,E>, PredecessorsFunction<N>, SuccessorsFunction<N>
Direct Known Subclasses:
ImmutableNetwork, StandardMutableNetwork

class StandardNetwork<N,E> extends AbstractNetwork<N,E>
Standard implementation of Network that supports the options supplied by NetworkBuilder.

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 Details

    • 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

      final MapIteratorCache<N,NetworkConnections<N,E>> nodeConnections
    • edgeToReferenceNode

      final MapIteratorCache<E,N> edgeToReferenceNode
  • Constructor Details

    • StandardNetwork

      StandardNetwork(NetworkBuilder<? super N,? super E> builder)
      Constructs a graph with the properties specified in builder.
    • StandardNetwork

      StandardNetwork(NetworkBuilder<? super N,? super E> builder, Map<N,NetworkConnections<N,E>> nodeConnections, Map<E,N> edgeToReferenceNode)
      Constructs a graph with the properties specified in builder, initialized with the given node and edge maps.
  • Method Details

    • nodes

      public Set<N> nodes()
      Description copied from interface: Network
      Returns all nodes in this network, in the order specified by Network.nodeOrder().
    • edges

      public Set<E> edges()
      Description copied from interface: Network
      Returns all edges in this network, in the order specified by Network.edgeOrder().
    • isDirected

      public boolean isDirected()
      Description copied from interface: Network
      Returns true if the edges in this network are directed. Directed edges connect a source node to a target 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 an IllegalArgumentException.
    • 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 an IllegalArgumentException.
    • nodeOrder

      public ElementOrder<N> nodeOrder()
      Description copied from interface: Network
      Returns the order of iteration for the elements of Network.nodes().
    • edgeOrder

      public ElementOrder<E> edgeOrder()
      Description copied from interface: Network
      Returns the order of iteration for the elements of Network.edges().
    • incidentEdges

      public Set<E> incidentEdges(N node)
      Description copied from interface: Network
      Returns a live view of the edges whose incident nodes in this network include node.

      This is equal to the union of Network.inEdges(Object) and Network.outEdges(Object).

      If node is removed from the network after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:

      • view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
      • hashCode() does not throw
      • if node is re-added to the network after having been removed, view's behavior is undefined
    • incidentNodes

      public EndpointPair<N> incidentNodes(E edge)
      Description copied from interface: Network
      Returns the nodes which are the endpoints of edge in this network.
    • adjacentNodes

      public Set<N> adjacentNodes(N node)
      Description copied from interface: Network
      Returns a live view of the nodes which have an incident edge in common with node in this graph.

      This is equal to the union of Network.predecessors(Object) and Network.successors(Object).

      If node is removed from the network after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:

      • view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
      • hashCode() does not throw
      • if node is re-added to the network after having been removed, view's behavior is undefined
    • edgesConnecting

      public Set<E> edgesConnecting(N nodeU, N nodeV)
      Description copied from interface: Network
      Returns a live view of the set of edges that each directly connect nodeU to nodeV.

      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 not allow parallel edges, the resulting set will contain at most one edge (equivalent to edgeConnecting(nodeU, nodeV).asSet()).

      If either nodeU or nodeV are removed from the network after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:

      • view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
      • hashCode() does not throw
      • if nodeU or nodeV are re-added to the network after having been removed, view's behavior is undefined
      Specified by:
      edgesConnecting in interface Network<N,E>
      Overrides:
      edgesConnecting in class AbstractNetwork<N,E>
    • inEdges

      public Set<E> inEdges(N node)
      Description copied from interface: Network
      Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge to end at node.

      In a directed network, an incoming edge's EndpointPair.target() equals node.

      In an undirected network, this is equivalent to Network.incidentEdges(Object).

      If node is removed from the network after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:

      • view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
      • hashCode() does not throw
      • if node is re-added to the network after having been removed, view's behavior is undefined
    • outEdges

      public Set<E> outEdges(N node)
      Description copied from interface: Network
      Returns a live view of all edges in this network which can be traversed in the direction (if any) of the edge starting from node.

      In a directed network, an outgoing edge's EndpointPair.source() equals node.

      In an undirected network, this is equivalent to Network.incidentEdges(Object).

      If node is removed from the network after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:

      • view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
      • hashCode() does not throw
      • if node is re-added to the network after having been removed, view's behavior is undefined
    • predecessors

      public Set<N> predecessors(N node)
      Description copied from interface: Network
      Returns a live view of all nodes in this network adjacent to node which can be reached by traversing node's incoming edges against the direction (if any) of the edge.

      In an undirected network, this is equivalent to Network.adjacentNodes(Object).

      If node is removed from the network after this method is called, the `Set` returned by this method will be invalidated, and will throw `IllegalStateException` if it is accessed in any way.

    • successors

      public Set<N> successors(N node)
      Description copied from interface: Network
      Returns a live view of all nodes in this network adjacent to node which can be reached by traversing node'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, see Graphs.reachableNodes(Graph, Object).

      If node is removed from the network after this method is called, the Set view returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way, with the following exceptions:

      • view.equals(view) evaluates to true (but any other `equals()` expression involving view will throw)
      • hashCode() does not throw
      • if node is re-added to the network after having been removed, view's behavior is undefined
    • checkedConnections

      final NetworkConnections<N,E> checkedConnections(N node)
    • checkedReferenceNode

      final N checkedReferenceNode(E edge)
    • containsNode

      final boolean containsNode(N node)
    • containsEdge

      final boolean containsEdge(E edge)