Class ImmutableNetwork<N,​E>

  • Type Parameters:
    N - Node parameter type
    E - Edge parameter type
    All Implemented Interfaces:
    Network<N,​E>

    @Beta
    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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.google.common.graph.MapIteratorCache<E,​N> edgeToReferenceNode  
      protected com.google.common.graph.MapIteratorCache<N,​com.google.common.graph.NetworkConnections<N,​E>> nodeConnections  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated 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 with node 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).
      ImmutableGraph<N> asGraph()
      Returns a live view of this network as a Graph.
      protected com.google.common.graph.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)  
      static <N,​E>
      ImmutableNetwork<N,​E>
      copyOf​(ImmutableNetwork<N,​E> network)
      Deprecated.
      no need to use this
      static <N,​E>
      ImmutableNetwork<N,​E>
      copyOf​(Network<N,​E> network)
      Returns an immutable copy of network.
      ElementOrder<E> edgeOrder()
      Returns the order of iteration for the elements of Network.edges().
      java.util.Set<E> edges()
      Returns all edges in this network, in the order specified by Network.edgeOrder().
      java.util.Set<E> edgesConnecting​(java.lang.Object nodeU, java.lang.Object nodeV)
      Returns the set of edges directly connecting nodeU to nodeV.
      java.util.Set<E> incidentEdges​(java.lang.Object node)
      Returns the edges whose incident nodes in this network include node.
      EndpointPair<N> incidentNodes​(java.lang.Object edge)
      Returns the nodes which are the endpoints of edge 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 at node.
      boolean isDirected()
      Returns true if the edges in this network are directed.
      ElementOrder<N> nodeOrder()
      Returns the order of iteration for the elements of Network.nodes().
      java.util.Set<N> nodes()
      Returns all nodes in this network, in the order specified by Network.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 from node.
      java.util.Set<N> predecessors​(java.lang.Object node)
      Returns 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.
      java.util.Set<N> successors​(java.lang.Object node)
      Returns 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.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • nodeConnections

        protected final com.google.common.graph.MapIteratorCache<N,​com.google.common.graph.NetworkConnections<N,​E>> nodeConnections
      • edgeToReferenceNode

        protected final com.google.common.graph.MapIteratorCache<E,​N> edgeToReferenceNode
    • Method Detail

      • copyOf

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

        @Deprecated
        public static <N,​E> ImmutableNetwork<N,​E> copyOf​(ImmutableNetwork<N,​E> network)
        Deprecated.
        no need to use this
        Simply returns its argument.
      • nodes

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

        public java.util.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 UnsupportedOperationException.
      • 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 UnsupportedOperationException.
      • incidentEdges

        public java.util.Set<E> incidentEdges​(java.lang.Object node)
        Description copied from interface: Network
        Returns the edges whose incident nodes in this network include node.
      • incidentNodes

        public EndpointPair<N> incidentNodes​(java.lang.Object edge)
        Description copied from interface: Network
        Returns the nodes which are the endpoints of edge 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 with node 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 connecting 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.

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

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

      • predecessors

        public java.util.Set<N> predecessors​(java.lang.Object node)
        Description copied from interface: Network
        Returns 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).

      • successors

        public java.util.Set<N> successors​(java.lang.Object node)
        Description copied from interface: Network
        Returns 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).

      • checkedConnections

        protected final com.google.common.graph.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)