Class ImmutableNetwork<N,E>

java.lang.Object
com.google.common.graph.AbstractNetwork<N,E>
com.google.common.graph.ImmutableNetwork<N,E>
Type Parameters:
N - Node parameter type
E - Edge parameter type
All Implemented Interfaces:
Network<N,E>, PredecessorsFunction<N>, SuccessorsFunction<N>
@Beta @Immutable(containerOf={"N","E"}) public final class ImmutableNetwork<N,E> extends AbstractNetwork<N,E>
A Network whose elements and structural relationships will never change. Instances of this class may be obtained with copyOf(Network).

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, Joshua O'Madadhain, Omar Darwish, Jens Nyman

  • Method Details

    • copyOf

      public static <N,E> ImmutableNetwork<N,E> copyOf(Network<N,E> network)
      Returns an immutable copy of network.

    • copyOf

      @InlineMe(replacement="checkNotNull(network)", staticImports="com.google.common.base.Preconditions.checkNotNull") @Deprecated public static <N,E> ImmutableNetwork<N,E> copyOf(ImmutableNetwork<N,E> network)
      Deprecated.
      no need to use this
      Simply returns its argument.

    • asGraph

      public ImmutableGraph<N> asGraph()
      Description copied from interface: Network
      Returns a live view of this network as a Graph. The resulting Graph will have an edge connecting node A to node B if this Network has an edge connecting A to B.

      If this network allows parallel edges, parallel edges will be treated as if collapsed into a single edge. For example, the Network.degree(Object) of a node in the Graph view may be less than the degree of the same node in this Network.

      Specified by:
      asGraph in interface Network<N,E>
      Overrides:
      asGraph in class AbstractNetwork<N,E>

    • nodes

      public Set<N> nodes()

    • 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()

    • 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()

    • nodeOrder

      public ElementOrder<N> nodeOrder()

    • 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)

    • 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: PredecessorsFunction
      Returns all nodes in this graph adjacent to node which can be reached by traversing node's incoming edges against the direction (if any) of the edge.

      Some algorithms that operate on a PredecessorsFunction may produce undesired results if the returned Iterable contains duplicate elements. Implementations of such algorithms should document their behavior in the presence of duplicates.

      The elements of the returned Iterable must each be:

      • Non-null
      • Usable as Map keys (see the Guava User Guide's section on graph elements for details)

    • successors

      public Set<N> successors(N node)
      Description copied from interface: SuccessorsFunction
      Returns all nodes in this graph adjacent to node which can be reached by traversing node's outgoing edges in the direction (if any) of the edge.

      This is not the same as "all nodes reachable from node by following outgoing edges". For that functionality, see Graphs.reachableNodes(Graph, Object).

      Some algorithms that operate on a SuccessorsFunction may produce undesired results if the returned Iterable contains duplicate elements. Implementations of such algorithms should document their behavior in the presence of duplicates.

      The elements of the returned Iterable must each be:

      • Non-null
      • Usable as Map keys (see the Guava User Guide's section on graph elements for details)