Package edu.uci.ics.jung.graph
Interface Forest<V,E>
-
- All Superinterfaces:
DirectedGraph<V,E>
,Graph<V,E>
,Hypergraph<V,E>
- All Known Subinterfaces:
Tree<V,E>
- All Known Implementing Classes:
DelegateForest
,DelegateTree
,OrderedKAryTree
public interface Forest<V,E> extends DirectedGraph<V,E>
An interface for a graph which consists of a collection of rooted directed acyclic graphs.- Author:
- Joshua O'Madadhain
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getChildCount(V vertex)
Returns the number of children thatvertex
has in this tree.java.util.Collection<E>
getChildEdges(V vertex)
Returns the edges connectingvertex
to its children in this tree.java.util.Collection<V>
getChildren(V vertex)
Returns the children ofvertex
in this tree.V
getParent(V vertex)
Returns the parent ofvertex
in this tree.E
getParentEdge(V vertex)
Returns the edge connectingvertex
to its parent in this tree.java.util.Collection<Tree<V,E>>
getTrees()
Returns a view of this graph as a collection ofTree
instances.-
Methods inherited from interface edu.uci.ics.jung.graph.Graph
addEdge, addEdge, getDest, getEndpoints, getInEdges, getOpposite, getOutEdges, getPredecessorCount, getPredecessors, getSource, getSuccessorCount, getSuccessors, inDegree, isDest, isPredecessor, isSource, isSuccessor, outDegree
-
Methods inherited from interface edu.uci.ics.jung.graph.Hypergraph
addEdge, addEdge, addVertex, containsEdge, containsVertex, degree, findEdge, findEdgeSet, getDefaultEdgeType, getEdgeCount, getEdgeCount, getEdges, getEdges, getEdgeType, getIncidentCount, getIncidentEdges, getIncidentVertices, getNeighborCount, getNeighbors, getVertexCount, getVertices, isIncident, isNeighbor, removeEdge, removeVertex
-
-
-
-
Method Detail
-
getTrees
java.util.Collection<Tree<V,E>> getTrees()
Returns a view of this graph as a collection ofTree
instances.- Returns:
- a view of this graph as a collection of
Tree
s
-
getParent
V getParent(V vertex)
Returns the parent ofvertex
in this tree. (Ifvertex
is the root, returnsnull
.) 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 toGraph.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 connectingvertex
to its parent in this tree. (Ifvertex
is the root, returnsnull
.) 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 toGraph.getInEdges(vertex).iterator().next()
, and also toGraph.findEdge(vertex, getParent(vertex))
.- Parameters:
vertex
- the vertex whose incoming edge is to be returned- Returns:
- the edge connecting
vertex
to its parent, ornull
ifvertex
is the root - See Also:
Graph.getInEdges(Object)
,getParent(Object)
-
getChildren
java.util.Collection<V> getChildren(V vertex)
Returns the children ofvertex
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 forgetSuccessors(vertex)
.- Parameters:
vertex
- the vertex whose children are to be returned- Returns:
- the
Collection
of children ofvertex
in this tree - See Also:
Graph.getSuccessors(Object)
,getChildEdges(Object)
-
getChildEdges
java.util.Collection<E> getChildEdges(V vertex)
Returns the edges connectingvertex
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 forgetOutEdges(vertex)
.- Parameters:
vertex
- the vertex whose child edges are to be returned- Returns:
- the
Collection
of edges connectingvertex
to its children in this tree - See Also:
Graph.getOutEdges(Object)
,getChildren(Object)
-
getChildCount
int getChildCount(V vertex)
Returns the number of children thatvertex
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 forgetSuccessorCount(vertex)
.- Parameters:
vertex
- the vertex whose child edges are to be returned- Returns:
- the
Collection
of edges connectingvertex
to its children in this tree - See Also:
getChildEdges(Object)
,getChildren(Object)
,Graph.getSuccessorCount(Object)
-
-