public class OrderedKAryTree<V,E> extends AbstractTypedGraph<V,E> implements Tree<V,E>
Tree in which each vertex has
<= k children. The value of 'k' is specified by the constructor
parameter. A specific child (edge) can be retrieved directly by specifying the
index at which the child is located. By default, new (child) vertices
are added at the lowest index available, if no index is specified.| Modifier and Type | Class and Description |
|---|---|
protected class |
OrderedKAryTree.VertexData |
| Modifier and Type | Field and Description |
|---|---|
protected java.util.Map<E,Pair<V>> |
edge_vpairs |
protected int |
height |
protected int |
order |
protected V |
root |
protected java.util.Map<V,OrderedKAryTree.VertexData> |
vertex_data |
edgeType| Constructor and Description |
|---|
OrderedKAryTree(int order)
Creates a new instance with the specified order (maximum number of children).
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
addEdge(E e,
V parent,
V child)
Adds edge
e to this graph such that it connects
vertex v1 to v2. |
boolean |
addEdge(E e,
V v1,
V v2,
EdgeType edgeType)
Adds edge
e to this graph such that it connects
vertex v1 to v2. |
boolean |
addEdge(E e,
V parent,
V child,
int index)
Adds the specified
child vertex and edge e to the graph
with the specified parent vertex parent. |
boolean |
addEdgeWithEndpoints(E edge,
Pair<? extends V> endpoints,
EdgeType edgeType)
Adds
edge to this graph with the specified endpoints
and EdgeType. |
boolean |
addEdgeWithVertices(E edge,
java.util.Collection<? extends V> vertices,
EdgeType edgeType)
Adds
edge to this graph with type edge_type. |
boolean |
addVertex(V vertex)
Adds
vertex to this graph. |
boolean |
containsEdge(E edge)
Returns true if this graph's edge collection contains
edge. |
boolean |
containsVertex(V vertex)
Returns true if this graph's vertex collection contains
vertex. |
E |
findEdge(V v1,
V v2)
Returns an edge that connects this vertex to
v. |
java.util.Collection<E> |
findEdgeSet(V v1,
V v2)
Returns all edges that connects this vertex to
v. |
V |
getChild(V vertex,
int index)
Returns the child of
vertex at position index
in this tree, or null if it has no child at that position. |
int |
getChildCount(V vertex)
Returns the number of children that
vertex has. |
E |
getChildEdge(V vertex,
int index)
Returns the child edge of the vertex at index
index. |
java.util.Collection<E> |
getChildEdges(V vertex)
Returns the edges connecting
vertex to its children
in this tree. |
java.util.Collection<V> |
getChildren(V vertex)
Returns an ordered list of
vertex's child vertices. |
int |
getDepth(V vertex)
Returns the (unweighted) distance of
vertex
from the root of this tree. |
V |
getDest(E directedEdge)
If
directed_edge is a directed edge in this graph, returns the destination;
otherwise returns null. |
int |
getEdgeCount()
Returns the number of edges in this graph.
|
java.util.Collection<E> |
getEdgesView()
Returns a view of all edges in this graph.
|
Pair<V> |
getEndpoints(E edge)
Returns the endpoints of
edge as a Pair. |
static <V,E> Factory<DirectedGraph<V,E>> |
getFactory(int order)
Returns a
Factory that creates an instance of this graph type. |
int |
getHeight()
Returns the height of the tree, or -1 if the tree is empty.
|
int |
getIncidentCount(E edge)
Returns the number of vertices that are incident to
edge. |
java.util.Collection<E> |
getIncidentEdges(V vertex)
Returns the collection of edges in this graph which are connected to
vertex. |
java.util.Collection<V> |
getIncidentVertices(E edge)
Returns the collection of vertices in this graph which are connected to
edge. |
java.util.Collection<E> |
getInEdges(V vertex)
Returns a
Collection view of the incoming edges incident to vertex in this graph. |
int |
getNeighborCount(V vertex)
Returns the number of vertices that are adjacent to
vertex (that is, the number of vertices that are incident
to edges in vertex's incident edge set). |
java.util.Collection<V> |
getNeighbors(V vertex)
Returns the collection of vertices which are connected to
vertex via any edges in this graph. |
V |
getOpposite(V vertex,
E edge)
Returns the vertex at the other end of
edge from vertex. |
java.util.Collection<E> |
getOutEdges(V vertex)
Returns a
Collection view of the outgoing edges incident to vertex
in this graph. |
V |
getParent(V vertex)
Returns the parent of
vertex in this tree. |
E |
getParentEdge(V vertex)
Returns the edge connecting
vertex to its parent in
this tree. |
int |
getPredecessorCount(V vertex)
Returns the number of predecessors that
vertex has in this graph. |
java.util.Collection<V> |
getPredecessors(V vertex)
Returns a
Collection view of the predecessors of vertex
in this graph. |
V |
getRoot()
Returns the root of this tree.
|
V |
getSource(E directedEdge)
If
directed_edge is a directed edge in this graph, returns the source;
otherwise returns null. |
int |
getSuccessorCount(V vertex)
Returns the number of successors that
vertex has in this graph. |
java.util.Collection<V> |
getSuccessors(V vertex)
Returns a
Collection view of the successors of vertex
in this graph. |
java.util.Collection<Tree<V,E>> |
getTrees()
Returns a view of this graph as a collection of
Tree instances. |
int |
getVertexCount()
Returns the number of vertices in this graph.
|
java.util.Collection<V> |
getVerticesView()
Returns a view of all vertices in this graph.
|
int |
inDegree(V vertex)
Returns the number of incoming edges incident to
vertex. |
boolean |
isDest(V vertex,
E edge)
Returns
true if vertex is the destination of edge. |
boolean |
isIncident(V vertex,
E edge)
Returns
true if vertex and edge
are incident to each other. |
boolean |
isLeaf(V vertex)
Returns
true if vertex is a leaf of this tree,
i.e., if it has no children. |
boolean |
isNeighbor(V v1,
V v2)
Returns
true if v1 and v2 share an incident edge. |
boolean |
isPredecessor(V v1,
V v2)
Returns true iff
v1 is the parent of v2. |
boolean |
isRoot(V vertex)
Returns
true if vertex is a leaf of this tree,
i.e., if it has no children. |
boolean |
isSource(V vertex,
E edge)
Returns
true if vertex is the source of edge. |
boolean |
isSuccessor(V v1,
V v2)
Returns
true if v1 is a successor of v2 in this graph. |
int |
outDegree(V vertex)
Returns the number of outgoing edges incident to
vertex. |
boolean |
removeEdge(E edge)
Removes
edge from this graph. |
boolean |
removeVertex(V vertex)
Removes
vertex from this graph. |
getDefaultEdgeType, getEdgeCount, getEdges, getEdgeType, hasEqualEdgeType, validateEdgeTypeaddEdgeWithEndPoints, addEdgeWithVertices, degree, getValidatedEndpointsclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddEdgeWithVertices, degree, getDefaultEdgeType, getEdgeCount, getEdges, getEdgeTypeprotected java.util.Map<V,OrderedKAryTree.VertexData> vertex_data
protected int height
protected V root
protected int order
public OrderedKAryTree(int order)
public static <V,E> Factory<DirectedGraph<V,E>> getFactory(int order)
Factory that creates an instance of this graph type.V - the vertex type for the graph factoryE - the edge type for the graph factorypublic int getChildCount(V vertex)
vertex has.getChildCount in interface Forest<V,E>vertex - the vertex whose child edges are to be returnedCollection of edges connecting
vertex to its children in this treeForest.getChildEdges(Object),
Forest.getChildren(Object),
Graph.getSuccessorCount(Object)public E getChildEdge(V vertex, int index)
index.vertex - index - indexpublic java.util.Collection<E> getChildEdges(V vertex)
Forestvertex 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).getChildEdges in interface Forest<V,E>vertex - the vertex whose child edges are to be returnedCollection of edges connecting
vertex to its children in this treeGraph.getOutEdges(Object),
Forest.getChildren(Object)public java.util.Collection<V> getChildren(V vertex)
vertex's child vertices.
If there is no child in position i, then the list will contain
null in position i. If vertex has no children
then the empty set will be returned.getChildren in interface Forest<V,E>vertex - the vertex whose children are to be returnedCollection of children of vertex
in this treeGraph.getSuccessors(Object),
Forest.getChildEdges(Object)public int getDepth(V vertex)
Treevertex
from the root of this tree.getDepth in interface Tree<V,E>vertex - the vertex whose depth is to be returned.Tree.getHeight()public int getHeight()
getHeight in interface Tree<V,E>Tree.getDepth(Object)public V getParent(V vertex)
Forestvertex 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().getParent in interface Forest<V,E>vertex in this treeGraph.getPredecessors(Object),
Forest.getParentEdge(Object)public E getParentEdge(V vertex)
Forestvertex 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)).getParentEdge in interface Forest<V,E>vertex to its parent, or
null if vertex is the rootGraph.getInEdges(Object),
Forest.getParent(Object)public V getRoot()
Treepublic java.util.Collection<Tree<V,E>> getTrees()
ForestTree instances.public boolean addEdge(E e, V parent, V child, int index)
child vertex and edge e to the graph
with the specified parent vertex parent. If index is
greater than or equal to 0, then the child is placed at position
index; if it is less than 0, the child is placed at the lowest
available position; if it is greater than or equal to the order of this
tree, an exception is thrown.public boolean addEdge(E e, V parent, V child)
Graphe to this graph such that it connects
vertex v1 to v2.
Equivalent to addEdge(e, new Pair(v1, v2)) .
If this graph does not contain v1, v2,
or both, implementations may choose to either silently add
the vertices to the graph or throw an IllegalArgumentException.
If this graph assigns edge types to its edges, the edge type of
e will be the default for this graph.
See Hypergraph.addEdge() for a listing of possible reasons
for failure.addEdge in interface Graph<V,E>addEdge in class AbstractGraph<V,E>e - the edge to be addedparent - the first vertex to be connectedchild - the second vertex to be connectedtrue if the add is successful, false otherwiseGraph.addEdge(Object, Object, Object, EdgeType)public boolean addEdge(E e, V v1, V v2, EdgeType edgeType)
Graphe to this graph such that it connects
vertex v1 to v2.
Equivalent to addEdge(e, new Pair(v1, v2)) .
If this graph does not contain v1, v2,
or both, implementations may choose to either silently add
the vertices to the graph or throw an IllegalArgumentException.
If edgeType is not legal for this graph, this method will
throw IllegalArgumentException.
See Hypergraph.addEdge() for a listing of possible reasons
for failure.addEdge in interface Graph<V,E>addEdge in class AbstractGraph<V,E>e - the edge to be addedv1 - the first vertex to be connectedv2 - the second vertex to be connectededgeType - the type to be assigned to the edgetrue if the add is successful, false otherwisepublic V getDest(E directedEdge)
Graphdirected_edge is a directed edge in this graph, returns the destination;
otherwise returns null.
The destination of a directed edge d is defined to be the vertex
incident to d for which
d is an incoming edge.
directed_edge is guaranteed to be a directed edge if
its EdgeType is DIRECTED.public Pair<V> getEndpoints(E edge)
Graphedge as a Pair.getEndpoints in interface Graph<V,E>edge - the edge whose endpoints are to be returnededgepublic java.util.Collection<E> getInEdges(V vertex)
GraphCollection view of the incoming edges incident to vertex in this graph.getInEdges in interface Graph<V,E>getInEdges in interface Hypergraph<V,E>vertex - the vertex whose incoming edges are to be returnedCollection view of the incoming edges incident
to vertex in this graphpublic V getOpposite(V vertex, E edge)
Graphedge from vertex.
(That is, returns the vertex incident to edge which is not vertex.)getOpposite in interface Graph<V,E>getOpposite in class AbstractGraph<V,E>vertex - the vertex to be queriededge - the edge to be queriededge from vertexpublic java.util.Collection<E> getOutEdges(V vertex)
GraphCollection view of the outgoing edges incident to vertex
in this graph.getOutEdges in interface Graph<V,E>getOutEdges in interface Hypergraph<V,E>vertex - the vertex whose outgoing edges are to be returnedCollection view of the outgoing edges incident
to vertex in this graphpublic int getPredecessorCount(V vertex)
Graphvertex has in this graph.
Equivalent to vertex.getPredecessors().size().getPredecessorCount in interface Graph<V,E>getPredecessorCount in class AbstractGraph<V,E>vertex - the vertex whose predecessor count is to be returnedvertex is the root, -1 if the vertex is
not an element of this tree, and 1 otherwisepublic java.util.Collection<V> getPredecessors(V vertex)
GraphCollection view of the predecessors of vertex
in this graph. A predecessor of vertex is defined as a vertex v
which is connected to
vertex by an edge e, where e is an outgoing edge of
v and an incoming edge of vertex.getPredecessors in interface Graph<V,E>getPredecessors in interface Hypergraph<V,E>vertex - the vertex whose predecessors are to be returnedCollection view of the predecessors of
vertex in this graphpublic V getSource(E directedEdge)
Graphdirected_edge is a directed edge in this graph, returns the source;
otherwise returns null.
The source of a directed edge d is defined to be the vertex for which
d is an outgoing edge.
directed_edge is guaranteed to be a directed edge if
its EdgeType is DIRECTED.public int getSuccessorCount(V vertex)
Graphvertex has in this graph.
Equivalent to vertex.getSuccessors().size().getSuccessorCount in interface Graph<V,E>getSuccessorCount in class AbstractGraph<V,E>vertex - the vertex whose successor count is to be returnedvertex has in this graphpublic java.util.Collection<V> getSuccessors(V vertex)
GraphCollection view of the successors of vertex
in this graph. A successor of vertex is defined as a vertex v
which is connected to
vertex by an edge e, where e is an incoming edge of
v and an outgoing edge of vertex.getSuccessors in interface Graph<V,E>getSuccessors in interface Hypergraph<V,E>vertex - the vertex whose predecessors are to be returnedCollection view of the successors of
vertex in this graphpublic int inDegree(V vertex)
Graphvertex.
Equivalent to getInEdges(vertex).size().public boolean isDest(V vertex, E edge)
Graphtrue if vertex is the destination of edge.
Equivalent to getDest(edge).equals(vertex).public boolean isLeaf(V vertex)
true if vertex is a leaf of this tree,
i.e., if it has no children.vertex - the vertex to be queriedtrue if outDegree(vertex)==0public boolean isPredecessor(V v1, V v2)
v1 is the parent of v2.
Note that if v2 is the root and v1 is null,
this method returns true.isPredecessor in interface Graph<V,E>isPredecessor in class AbstractGraph<V,E>v1 - the first vertex to be queriedv2 - the second vertex to be queriedtrue if v1 is a predecessor of v2, and false otherwise.public boolean isRoot(V vertex)
true if vertex is a leaf of this tree,
i.e., if it has no children.vertex - the vertex to be queriedtrue if outDegree(vertex)==0public boolean isSource(V vertex, E edge)
Graphtrue if vertex is the source of edge.
Equivalent to getSource(edge).equals(vertex).public boolean isSuccessor(V v1, V v2)
Graphtrue if v1 is a successor of v2 in this graph.
Equivalent to v1.getSuccessors().contains(v2).isSuccessor in interface Graph<V,E>isSuccessor in class AbstractGraph<V,E>v1 - the first vertex to be queriedv2 - the second vertex to be queriedtrue if v1 is a successor of v2, and false otherwise.public int outDegree(V vertex)
Graphvertex.
Equivalent to getOutEdges(vertex).size().public boolean addEdgeWithVertices(E edge, java.util.Collection<? extends V> vertices, EdgeType edgeType)
Hypergraphedge to this graph with type edge_type. Fails under the following circumstances:
edge is already an element of the graphedge or vertices is nullvertices has the wrong number of vertices for the graph typevertices are already connected by another edge in this graph, and this graph does not accept parallel edgesedgeType is not legal for this graphaddEdgeWithVertices in interface Hypergraph<V,E>addEdgeWithVertices in class AbstractGraph<V,E>edge - the edgevertices - the verticesedgeType - the edge typetrue if the add is successful, and false otherwisepublic boolean addVertex(V vertex)
Hypergraphvertex to this graph. Fails if vertex is null or already in the graph.addVertex in interface Hypergraph<V,E>vertex - the vertex to addtrue if the add is successful, and false otherwisepublic boolean isIncident(V vertex, E edge)
Hypergraphtrue if vertex and edge
are incident to each other.
Equivalent to getIncidentEdges(vertex).contains(edge) and to
getIncidentVertices(edge).contains(vertex).isIncident in interface Hypergraph<V,E>isIncident in class AbstractGraph<V,E>vertex - the vertexedge - the edgetrue if vertex and edge
are incident to each otherpublic boolean isNeighbor(V v1, V v2)
Hypergraphtrue if v1 and v2 share an incident edge.
Equivalent to getNeighbors(v1).contains(v2).isNeighbor in interface Hypergraph<V,E>isNeighbor in class AbstractGraph<V,E>v1 - the first vertex to testv2 - the second vertex to testtrue if v1 and v2 share an incident edgepublic boolean containsEdge(E edge)
Hypergraphedge.
Equivalent to getEdges().contains(edge).containsEdge in interface Hypergraph<V,E>edge - the edge whose presence is being queriededgepublic boolean containsVertex(V vertex)
Hypergraphvertex. Equivalent to
getVertices().contains(vertex).containsVertex in interface Hypergraph<V,E>vertex - the vertex whose presence is being queriedvertexpublic E findEdge(V v1, V v2)
Hypergraphv. If this edge is not uniquely defined (that is, if the graph
contains more than one edge connecting v1 to v2), any of these edges may be returned.
findEdgeSet(v1, v2) may be used to return all such edges.
Returns null if either of the following is true:
v2 is not connected to v1v1 or v2 are not present in this graphv1 is only considered to be connected to
v2 via a given directed edge e if
v1 == e.getSource() && v2 == e.getDest() evaluates to true.
(v1 and v2 are connected by an undirected edge u if
u is incident to both v1 and v2.)findEdge in interface Hypergraph<V,E>findEdge in class AbstractGraph<V,E>v1 - the first vertexv2 - the second vertexv1 to v2, or null if no such edge exists (or either
vertex is not present)Hypergraph.findEdgeSet(Object, Object)public java.util.Collection<E> findEdgeSet(V v1, V v2)
Hypergraphv. If this edge is not uniquely defined (that is, if the graph
contains more than one edge connecting v1 to v2), any of these edges may be returned.
findEdgeSet(v1, v2) may be used to return all such edges.
Returns null if v2 is not connected to v1. Returns an empty collection if either v1
or v2 are not present in this graph.
Note: for purposes of this method, v1 is only considered to be connected to
v2 via a given directed edge d if
v1 == d.getSource() && v2 == d.getDest() evaluates to true.
(v1 and v2 are connected by an undirected edge u if
u is incident to both v1 and v2.)findEdgeSet in interface Hypergraph<V,E>findEdgeSet in class AbstractGraph<V,E>v1 - the first vertexv2 - the second vertexv1 to v2,
or null if either vertex is not presentHypergraph.findEdge(Object, Object)public V getChild(V vertex, int index)
vertex at position index
in this tree, or null if it has no child at that position.vertex - the vertex to queryvertex at position index
in this tree, or null if it has no child at that positionjava.lang.ArrayIndexOutOfBoundsException - if index is not in
the range [0, order-1]public int getEdgeCount()
HypergraphgetEdgeCount in interface Hypergraph<V,E>public java.util.Collection<E> getEdgesView()
HypergraphCollection contract, and therefore
makes no guarantees about the ordering of the vertices within the set.getEdgesView in interface Hypergraph<V,E>Collection view of all edges in this graphpublic int getIncidentCount(E edge)
Hypergraphedge. For hyperedges, this can be any nonnegative integer; for edges this
must be 2 (or 1 if self-loops are permitted).
Equivalent to getIncidentVertices(edge).size().getIncidentCount in interface Hypergraph<V,E>getIncidentCount in class AbstractGraph<V,E>edge - the edge whose incident vertex count is to be returnededge.public java.util.Collection<E> getIncidentEdges(V vertex)
Hypergraphvertex.getIncidentEdges in interface Hypergraph<V,E>vertex - the vertex whose incident edges are to be returnedvertex,
or null if vertex is not presentpublic java.util.Collection<V> getIncidentVertices(E edge)
Hypergraphedge.
Note that for some graph types there are guarantees about the size of this collection
(i.e., some graphs contain edges that have exactly two endpoints, which may or may
not be distinct). Implementations for those graph types may provide alternate methods
that provide more convenient access to the vertices.getIncidentVertices in interface Hypergraph<V,E>getIncidentVertices in class AbstractGraph<V,E>edge - the edge whose incident vertices are to be returnededge,
or null if edge is not presentpublic int getNeighborCount(V vertex)
Hypergraphvertex (that is, the number of vertices that are incident
to edges in vertex's incident edge set).
Equivalent to getNeighbors(vertex).size().getNeighborCount in interface Hypergraph<V,E>getNeighborCount in class AbstractGraph<V,E>vertex - the vertex whose neighbor count is to be returnedpublic java.util.Collection<V> getNeighbors(V vertex)
Hypergraphvertex via any edges in this graph.
If vertex is connected to itself with a self-loop, then it will be included in the collection returned.getNeighbors in interface Hypergraph<V,E>vertex - the vertex whose neighbors are to be returnedvertex,
or null if vertex is not presentpublic int getVertexCount()
HypergraphgetVertexCount in interface Hypergraph<V,E>public java.util.Collection<V> getVerticesView()
HypergraphCollection contract, and therefore makes no guarantees
about the ordering of the vertices within the set.getVerticesView in interface Hypergraph<V,E>Collection view of all vertices in this graphpublic boolean removeEdge(E edge)
Hypergraphedge from this graph.
Fails if edge is null, or is otherwise not an element of this graph.removeEdge in interface Hypergraph<V,E>edge - the edge to removetrue if the removal is successful, false otherwisepublic boolean removeVertex(V vertex)
Hypergraphvertex from this graph. As a side effect, removes any edges e incident to vertex if the
removal of vertex would cause e to be incident to an illegal number of vertices. (Thus, for example,
incident hyperedges are not removed, but incident edges--which must be connected to a vertex at both endpoints--are removed.)
Fails under the following circumstances:
vertex is not an element of this graphvertex is nullremoveVertex in interface Hypergraph<V,E>vertex - the vertex to removetrue if the removal is successful, false otherwisepublic boolean addEdgeWithEndpoints(E edge, Pair<? extends V> endpoints, EdgeType edgeType)
AbstractGraphedge to this graph with the specified endpoints
and EdgeType.addEdgeWithEndpoints in class AbstractGraph<V,E>Copyright © 2021, 2022 Herve Girod. All Rights Reserved. Documentation and source under the BSD 3-Clause licence