Interface Forest<V,​E>

    • Method Detail

      • getTrees

        java.util.Collection<Tree<V,​E>> getTrees()
        Returns a view of this graph as a collection of Tree instances.
        Returns:
        a view of this graph as a collection of Trees
      • getParent

        V getParent​(V vertex)
        Returns the parent of vertex in this tree. (If vertex is the root, returns null.) The parent of a vertex is defined as being its predecessor in the (unique) shortest path from the root to this vertex. This is a convenience method which is equivalent to Graph.getPredecessors(vertex).iterator().next().
        Parameters:
        vertex - the vertex whose parent is to be returned
        Returns:
        the parent of vertex in this tree
        See Also:
        Graph.getPredecessors(Object), getParentEdge(Object)
      • getParentEdge

        E getParentEdge​(V vertex)
        Returns the edge connecting vertex to its parent in this tree. (If vertex is the root, returns null.) The parent of a vertex is defined as being its predecessor in the (unique) shortest path from the root to this vertex. This is a convenience method which is equivalent to Graph.getInEdges(vertex).iterator().next(), and also to Graph.findEdge(vertex, getParent(vertex)).
        Parameters:
        vertex - the vertex whose incoming edge is to be returned
        Returns:
        the edge connecting vertex to its parent, or null if vertex is the root
        See Also:
        Graph.getInEdges(Object), getParent(Object)
      • getChildren

        java.util.Collection<V> getChildren​(V vertex)
        Returns the children of vertex in this tree. The children of a vertex are defined as being the successors of that vertex on the respective (unique) shortest paths from the root to those vertices. This is syntactic (maple) sugar for getSuccessors(vertex).
        Parameters:
        vertex - the vertex whose children are to be returned
        Returns:
        the Collection of children of vertex in this tree
        See Also:
        Graph.getSuccessors(Object), getChildEdges(Object)
      • getChildEdges

        java.util.Collection<E> getChildEdges​(V vertex)
        Returns the edges connecting vertex to its children in this tree. The children of a vertex are defined as being the successors of that vertex on the respective (unique) shortest paths from the root to those vertices. This is syntactic (maple) sugar for getOutEdges(vertex).
        Parameters:
        vertex - the vertex whose child edges are to be returned
        Returns:
        the Collection of edges connecting vertex to its children in this tree
        See Also:
        Graph.getOutEdges(Object), getChildren(Object)
      • getChildCount

        int getChildCount​(V vertex)
        Returns the number of children that vertex has in this tree. The children of a vertex are defined as being the successors of that vertex on the respective (unique) shortest paths from the root to those vertices. This is syntactic (maple) sugar for getSuccessorCount(vertex).
        Parameters:
        vertex - the vertex whose child edges are to be returned
        Returns:
        the Collection of edges connecting vertex to its children in this tree
        See Also:
        getChildEdges(Object), getChildren(Object), Graph.getSuccessorCount(Object)