Class ForwardingValueGraph<N,​V>

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete 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).
      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 abstract ValueGraph<N,​V> delegate()  
      protected long edgeCount()
      Defer to AbstractBaseGraph.edges() (based on successors(Object)) for full edges() implementation.
      java.util.Optional<V> edgeValue​(N nodeU, N nodeV)
      Returns the value of the edge connecting nodeU to nodeV, if one is present; otherwise, returns Optional.empty().
      V edgeValueOrDefault​(N nodeU, N nodeV, V defaultValue)
      Returns the value of the edge connecting nodeU to nodeV, if one is present; otherwise, returns defaultValue.
      boolean hasEdgeConnecting​(N nodeU, N nodeV)
      Returns true if there is an edge directly connecting nodeU to nodeV.
      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 ValueGraph.nodes().
      java.util.Set<N> nodes()
      Returns all nodes in this graph, in the order specified by ValueGraph.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
    • Constructor Detail

      • ForwardingValueGraph

        ForwardingValueGraph()
    • Method Detail

      • delegate

        protected abstract ValueGraph<N,​V> delegate()
      • 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.
      • adjacentNodes

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

      • degree

        public int degree​(N node)
        Description copied from interface: BaseGraph
        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 BaseGraph<N>
        Specified by:
        degree in interface ValueGraph<N,​V>
        Overrides:
        degree in class AbstractBaseGraph<N>
      • hasEdgeConnecting

        public boolean hasEdgeConnecting​(N nodeU,
                                         N nodeV)
        Description copied from interface: BaseGraph
        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 BaseGraph<N>
        Specified by:
        hasEdgeConnecting in interface ValueGraph<N,​V>
        Overrides:
        hasEdgeConnecting in class AbstractBaseGraph<N>
      • edgeValue

        public java.util.Optional<V> edgeValue​(N nodeU,
                                               N nodeV)
        Description copied from interface: ValueGraph
        Returns the value of the edge connecting nodeU to nodeV, if one is present; otherwise, returns Optional.empty().

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

        Specified by:
        edgeValue in interface ValueGraph<N,​V>
        Overrides:
        edgeValue in class AbstractValueGraph<N,​V>
      • edgeValueOrDefault

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

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