Package com.google.common.graph

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>
Direct Known Subclasses:
ImmutableValueGraph
@Beta public abstract 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

  • Method Details

    • copyOf

      public static <N> ImmutableGraph<N> copyOf(Graph<N> graph)
      Returns an immutable copy of graph.

    • copyOf

      @Deprecated public static <N> ImmutableGraph<N> copyOf(ImmutableGraph<N> graph)
      Deprecated.
      no need to use this
      Simply returns its argument.

    • delegate

      protected abstract Graph<N> delegate()

    • nodes

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

    • edges

      public Set<EndpointPair<N>> edges()
      Description copied from class: AbstractGraph
      A reasonable default implementation of Graph.edges() defined in terms of Graph.nodes() and Graph.successors(Object).
      Specified by:
      edges in interface Graph<N>
      Overrides:
      edges in class AbstractGraph<N>

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

    • 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(Object node)
      Description copied from interface: Graph
      Returns the nodes which have an incident edge in common with node in this graph.

    • predecessors

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

      In an undirected graph, this is equivalent to Graph.adjacentNodes(Object).

    • successors

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

      In an undirected graph, this is equivalent to Graph.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).

    • degree

      public int degree(Object 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 adjacentNodes(node).size() + (1 if node has an incident self-loop, 0 otherwise).

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

      Specified by:
      degree in interface Graph<N>
      Overrides:
      degree in class AbstractGraph<N>

    • inDegree

      public int inDegree(Object 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>
      Overrides:
      inDegree in class AbstractGraph<N>

    • outDegree

      public int outDegree(Object 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>
      Overrides:
      outDegree in class AbstractGraph<N>