Package com.google.common.graph

Class ImmutableValueGraph<N,​V>

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      Set<N> adjacentNodes​(N node)
      Returns a live view of 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).
      ImmutableGraph<N> asGraph()
      Returns a live view of this graph as a Graph.
      static <N,​V>
      ImmutableValueGraph<N,​V>      		 copyOf​(ImmutableValueGraph<N,​V> graph)
      Deprecated.
      no need to use this
      static <N,​V>
      ImmutableValueGraph<N,​V>      		 copyOf​(ValueGraph<N,​V> graph)
      Returns an immutable copy of graph.
      int degree​(N node)  
      protected long edgeCount()
      Returns the number of edges in this graph; used to calculate the size of Graph.edges().
      Set<EndpointPair<N>> edges()
      An implementation of BaseGraph.edges() defined in terms of Graph.nodes() and SuccessorsFunction.successors(Object).
      V edgeValueOrDefault​(EndpointPair<N> endpoints, V defaultValue)
      Returns the value of the edge that connects endpoints (in the order, if any, specified by endpoints), if one is present; otherwise, returns defaultValue.
      V edgeValueOrDefault​(N nodeU, N nodeV, V defaultValue)
      Returns the value of the edge that connects nodeU to nodeV, if one is present; otherwise, returns defaultValue.
      boolean hasEdgeConnecting​(EndpointPair<N> endpoints)
      Returns true if there is an edge that directly connects endpoints (in the order, if any, specified by endpoints).
      boolean hasEdgeConnecting​(N nodeU, N nodeV)
      Returns true if there is an edge that directly connects nodeU to nodeV.
      ElementOrder<N> incidentEdgeOrder()
      Returns an ElementOrder that specifies the order of iteration for the elements of ValueGraph.edges(), ValueGraph.adjacentNodes(Object), ValueGraph.predecessors(Object), ValueGraph.successors(Object) and ValueGraph.incidentEdges(Object).
      Set<EndpointPair<N>> incidentEdges​(N node)
      Returns a live view of the edges in this graph whose endpoints include node.
      int inDegree​(N node)  
      boolean isDirected()
      Returns true if the edges in this graph are directed.
      protected boolean isOrderingCompatible​(EndpointPair<?> endpoints)
      Returns true iff endpoints' ordering is compatible with the directionality of this graph.
      protected <T> Set<T> nodeInvalidatableSet​(Set<T> set, N node)  
      ElementOrder<N> nodeOrder()
      Returns the order of iteration for the elements of ValueGraph.nodes().
      protected <T> Set<T> nodePairInvalidatableSet​(Set<T> set, N nodeU, N nodeV)  
      Set<N> nodes()
      Returns all nodes in this graph, in the order specified by ValueGraph.nodeOrder().
      int outDegree​(N node)  
      Set<N> predecessors​(N node)
      Returns a live view of 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.
      Set<N> successors​(N node)
      Returns a live view of 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.
      protected void validateEndpoints​(EndpointPair<?> endpoints)
      Throws IllegalArgumentException if the ordering of endpoints is not compatible with the directionality of this graph.

    • Method Detail

      • isDirected

        public boolean isDirected()
        Description copied from interface: ValueGraph
        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: ValueGraph
        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.

      • adjacentNodes

        public Set<N> adjacentNodes​(N node)
        Description copied from interface: ValueGraph
        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 ValueGraph.predecessors(Object) and ValueGraph.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: ValueGraph
        Returns a live view of 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 ValueGraph.adjacentNodes(Object).

        If node is removed from the graph after this method is called, the Set returned by this method will be invalidated, and will throw IllegalStateException if it is accessed in any way.

      • successors

        public Set<N> successors​(N node)
        Description copied from interface: ValueGraph
        Returns a live view of 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 ValueGraph.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).

        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

      • incidentEdges

        public Set<EndpointPair<N>> incidentEdges​(N node)
        Description copied from interface: ValueGraph
        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 ValueGraph<N,​V>

      • hasEdgeConnecting

        public boolean hasEdgeConnecting​(N nodeU,
                                 N nodeV)
        Description copied from interface: ValueGraph
        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 ValueGraph<N,​V>

      • hasEdgeConnecting

        public boolean hasEdgeConnecting​(EndpointPair<N> endpoints)
        Description copied from interface: ValueGraph
        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 ValueGraph<N,​V>

      • edgeValueOrDefault

        @CheckForNull
public V edgeValueOrDefault​(N nodeU,
                            N nodeV,
                            @CheckForNull
                            V defaultValue)
        Description copied from interface: ValueGraph
        Returns the value of the edge that connects nodeU to nodeV, if one is present; otherwise, returns defaultValue.

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

      • edgeValueOrDefault

        @CheckForNull
public V edgeValueOrDefault​(EndpointPair<N> endpoints,
                            @CheckForNull
                            V defaultValue)
        Description copied from interface: ValueGraph
        Returns the value of the edge that connects endpoints (in the order, if any, specified by endpoints), if one is present; otherwise, returns defaultValue.

        If this graph is directed, the endpoints must be ordered.

      • edgeCount

        protected long edgeCount()
        Returns the number of edges in this graph; used to calculate the size of Graph.edges(). This implementation requires O(|N|) time. Classes extending this one may manually keep track of the number of edges as the graph is updated, and override this method for better performance.

      • degree

        public int degree​(N node)

      • inDegree

        public int inDegree​(N node)

      • outDegree

        public int outDegree​(N node)

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