Class ImmutableValueGraph<N,​V>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected long edgeCount  
      protected com.google.common.graph.MapIteratorCache<N,​com.google.common.graph.GraphConnections<N,​V>> nodeConnections  
    • 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).
      ImmutableGraph<N> asGraph()
      Returns a live view of this graph as a Graph.
      protected com.google.common.graph.GraphConnections<N,​V> checkedConnections​(N node)  
      protected boolean containsNode​(N node)  
      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 edges().
      java.util.Set<EndpointPair<N>> edges()
      An implementation of BaseGraph.edges() defined in terms of 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.
      protected V edgeValueOrDefault_internal​(N nodeU, N nodeV, V 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.
      protected boolean hasEdgeConnecting_internal​(N nodeU, N nodeV)  
      ElementOrder<N> incidentEdgeOrder()
      java.util.Set<EndpointPair<N>> incidentEdges​(N node)
      Returns 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)  
      ElementOrder<N> nodeOrder()
      Returns the order of iteration for the elements of ValueGraph.nodes().
      java.util.Set<N> nodes()
      Returns all nodes in this graph, in the order specified by ValueGraph.nodeOrder().
      int outDegree​(N node)  
      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.
      protected void validateEndpoints​(EndpointPair<?> endpoints)
      Throws IllegalArgumentException if the ordering of endpoints is not compatible with the directionality of this graph.
      • Methods inherited from class java.lang.Object

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

      • nodeConnections

        protected final com.google.common.graph.MapIteratorCache<N,​com.google.common.graph.GraphConnections<N,​V>> nodeConnections
      • edgeCount

        protected long edgeCount
    • Method Detail

      • nodes

        public java.util.Set<N> nodes()
        Description copied from interface: ValueGraph
        Returns all nodes in this graph, in the order specified by ValueGraph.nodeOrder().
      • 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.
      • predecessors

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

      • successors

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

      • incidentEdges

        public java.util.Set<EndpointPair<N>> incidentEdges​(N node)
        Description copied from interface: ValueGraph
        Returns the edges in this graph whose endpoints include node.

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

        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

        public V edgeValueOrDefault​(N nodeU,
                                    N nodeV,
                                    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

        public V edgeValueOrDefault​(EndpointPair<N> endpoints,
                                    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 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.
      • checkedConnections

        protected final com.google.common.graph.GraphConnections<N,​V> checkedConnections​(N node)
      • containsNode

        protected final boolean containsNode​(N node)
      • hasEdgeConnecting_internal

        protected final boolean hasEdgeConnecting_internal​(N nodeU,
                                                           N nodeV)
      • edgeValueOrDefault_internal

        protected final V edgeValueOrDefault_internal​(N nodeU,
                                                      N nodeV,
                                                      V defaultValue)
      • 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)