Class ImmutableGraph<N>

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

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> ImmutableGraph<N> copyOf(Graph<N> graph)
      Returns an immutable copy of graph.

    • copyOf

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

    • incidentEdgeOrder

      public ElementOrder<N> incidentEdgeOrder()
      Description copied from interface: Graph
      Returns an ElementOrder that specifies the order of iteration for the elements of Graph.edges(), Graph.adjacentNodes(Object), Graph.predecessors(Object), Graph.successors(Object) and Graph.incidentEdges(Object).
      Specified by:
      incidentEdgeOrder in interface Graph<N>

    • nodes

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

    • edgeCount

      protected long edgeCount()
      Defer to BaseGraph.edges() (based on Graph.successors(Object)) for full edges() implementation.

    • isDirected

      public boolean isDirected()
      Description copied from interface: Graph
      Returns true if the edges in this graph are directed. Directed edges connect a source node to a target node, while undirected edges connect a pair of nodes to each other.

    • allowsSelfLoops

      public boolean allowsSelfLoops()
      Description copied from interface: Graph
      Returns 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 an IllegalArgumentException.

    • nodeOrder

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

    • adjacentNodes

      public Set<N> adjacentNodes(N node)
      Description copied from interface: Graph
      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 Graph.predecessors(Object) and Graph.successors(Object).

      If node is removed from the graph 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 graph 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)

    • incidentEdges

      public Set<EndpointPair<N>> incidentEdges(N node)
      Description copied from interface: Graph
      Returns a live view of the edges in this graph whose endpoints include node.

      This is equal to the union of incoming and outgoing edges.

      If node is removed from the graph 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 graph after having been removed, view's behavior is undefined
      Specified by:
      incidentEdges in interface Graph<N>

    • degree

      public int degree(N node)
      Description copied from interface: Graph
      Returns the count of node's incident edges, counting self-loops twice (equivalently, the number of times an edge touches node).

      For directed graphs, this is equal to inDegree(node) + outDegree(node).

      For undirected graphs, this is equal to incidentEdges(node).size() + (number of self-loops incident to node).

      If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.

      Specified by:
      degree in interface Graph<N>

    • inDegree

      public int inDegree(N node)
      Description copied from interface: Graph
      Returns the count of node's incoming edges (equal to predecessors(node).size()) in a directed graph. In an undirected graph, returns the Graph.degree(Object).

      If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.

      Specified by:
      inDegree in interface Graph<N>

    • outDegree

      public int outDegree(N node)
      Description copied from interface: Graph
      Returns the count of node's outgoing edges (equal to successors(node).size()) in a directed graph. In an undirected graph, returns the Graph.degree(Object).

      If the count is greater than Integer.MAX_VALUE, returns Integer.MAX_VALUE.

      Specified by:
      outDegree in interface Graph<N>

    • hasEdgeConnecting

      public boolean hasEdgeConnecting(N nodeU, N nodeV)
      Description copied from interface: Graph
      Returns true if there is an edge that directly connects nodeU to nodeV. This is equivalent to nodes().contains(nodeU) && successors(nodeU).contains(nodeV).

      In an undirected graph, this is equal to hasEdgeConnecting(nodeV, nodeU).

      Specified by:
      hasEdgeConnecting in interface Graph<N>

    • hasEdgeConnecting

      public boolean hasEdgeConnecting(EndpointPair<N> endpoints)
      Description copied from interface: Graph
      Returns true if there is an edge that directly connects endpoints (in the order, if any, specified by endpoints). This is equivalent to edges().contains(endpoints).

      Unlike the other EndpointPair-accepting methods, this method does not throw if the endpoints are unordered and the graph is directed; it simply returns false. This is for consistency with the behavior of Collection.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 with edges().contains(endpoints).

      Specified by:
      hasEdgeConnecting in interface Graph<N>

    • asNetwork

      Network<N, EndpointPair<N>> asNetwork()
      Returns a live view of this graph as a Network whose edges E are EndpointPair<N> objects (that is, a Network<N, EndpointPair<N>>). The resulting Network's edge-oriented methods (such as inEdges()) will return views transformed from the corresponding node-oriented methods (such as predecessors()).

      This capability facilitates writing implementations of edge-oriented code.

      Since:
      NEXT

    • edges

      public Set<EndpointPair<N>> edges()
      An implementation of BaseGraph.edges() defined in terms of Graph.nodes() and SuccessorsFunction.successors(Object).

    • asNetwork

      public Network<N, EndpointPair<N>> asNetwork()

    • validateEndpoints

      protected final void validateEndpoints(EndpointPair<?> endpoints)
      Throws IllegalArgumentException if the ordering of endpoints is not compatible with the directionality of this graph.

    • isOrderingCompatible

      protected final boolean isOrderingCompatible(EndpointPair<?> endpoints)
      Returns true iff endpoints' ordering is compatible with the directionality of this graph.

    • nodeInvalidatableSet

      protected final <T> Set<T> nodeInvalidatableSet(Set<T> set, N node)

    • nodePairInvalidatableSet

      protected final <T> Set<T> nodePairInvalidatableSet(Set<T> set, N nodeU, N nodeV)