Class ImmutableGraph<N>

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.Set<N> adjacentNodes​(N node)
      Returns the nodes which have an incident edge in common with node in this graph.
      boolean allowsSelfLoops()
      Returns true if this graph allows self-loops (edges that connect a node to itself).
      static <N> ImmutableGraph<N> copyOf​(Graph<N> graph)
      Returns an immutable copy of graph.
      static <N> ImmutableGraph<N> copyOf​(ImmutableGraph<N> graph)
      Deprecated.
      no need to use this
      int degree​(N node)
      Returns the count of node's incident edges, counting self-loops twice (equivalently, the number of times an edge touches node).
      protected com.google.common.graph.BaseGraph<N> delegate()  
      protected long edgeCount()
      Defer to BaseGraph.edges() (based on Graph.successors(Object)) for full edges() implementation.
      java.util.Set<EndpointPair<N>> edges()
      An implementation of BaseGraph.edges() defined in terms of nodes() and SuccessorsFunction.successors(Object).
      boolean hasEdgeConnecting​(N nodeU, N nodeV)
      Returns true if there is an edge directly connecting nodeU to nodeV.
      java.util.Set<EndpointPair<N>> incidentEdges​(N node)  
      int inDegree​(N node)
      Returns the count of node's incoming edges (equal to predecessors(node).size()) in a directed graph.
      boolean isDirected()
      Returns true if the edges in this graph are directed.
      ElementOrder<N> nodeOrder()
      Returns the order of iteration for the elements of Graph.nodes().
      java.util.Set<N> nodes()
      Returns all nodes in this graph, in the order specified by Graph.nodeOrder().
      int outDegree​(N node)
      Returns the count of node's outgoing edges (equal to successors(node).size()) in a directed graph.
      java.util.Set<N> predecessors​(N node)
      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.
      java.util.Set<N> successors​(N node)
      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.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • delegate

        protected com.google.common.graph.BaseGraph<Ndelegate()
      • nodes

        public java.util.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 java.util.Set<N> adjacentNodes​(N node)
        Description copied from interface: Graph
        Returns the nodes which have an incident edge in common with node in this graph.
      • predecessors

        public java.util.Set<N> predecessors​(N 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 java.util.Set<N> successors​(N 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​(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 directly connecting 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>
      • incidentEdges

        public java.util.Set<EndpointPair<N>> incidentEdges​(N node)