Class StandardValueGraph<N,​V>

    • Field Detail

      • isDirected

        private final boolean isDirected
      • allowsSelfLoops

        private final boolean allowsSelfLoops
      • edgeCount

        protected long edgeCount
    • Constructor Detail

      • StandardValueGraph

        StandardValueGraph​(AbstractGraphBuilder<? super N> builder)
        Constructs a graph with the properties specified in builder.
      • StandardValueGraph

        StandardValueGraph​(AbstractGraphBuilder<? super N> builder,
                           java.util.Map<N,​GraphConnections<N,​V>> nodeConnections,
                           long edgeCount)
        Constructs a graph with the properties specified in builder, initialized with the given node map.
    • 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).

      • hasEdgeConnecting

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

        public boolean hasEdgeConnecting​(EndpointPair<N> endpoints)
        Description copied from interface: BaseGraph
        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; 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 BaseGraph<N>
        Specified by:
        hasEdgeConnecting in interface ValueGraph<N,​V>
        Overrides:
        hasEdgeConnecting in class AbstractBaseGraph<N>
      • 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()
        Description copied from class: AbstractBaseGraph
        Returns the number of edges in this graph; used to calculate the size of AbstractBaseGraph.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.
        Overrides:
        edgeCount in class AbstractBaseGraph<N>
      • 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)