edu.uci.ics.jung.graph

Class OrderedKAryTree<V,E>

java.lang.Object

edu.uci.ics.jung.graph.AbstractGraph<V,E>

edu.uci.ics.jung.graph.AbstractTypedGraph<V,E>

edu.uci.ics.jung.graph.OrderedKAryTree<V,E>

All Implemented Interfaces:

DirectedGraph<V,E>, Forest<V,E>, Graph<V,E>, Hypergraph<V,E>, Tree<V,E>, Serializable

public class OrderedKAryTree<V,E>
extends AbstractTypedGraph<V,E>
implements Tree<V,E>

An implementation of 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	OrderedKAryTree.VertexData

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<E,Pair<V>>	edge_vpairs
protected int	height
protected int	order
protected V	root
protected Map<V,OrderedKAryTree.VertexData>	vertex_data

Fields inherited from class edu.uci.ics.jung.graph.AbstractTypedGraph

edge_type

Constructor Summary

Constructors

Constructor and Description
OrderedKAryTree(int order) Creates a new instance with the specified order (maximum number of children).

Method Summary

Modifier and Type	Method and Description
boolean	addEdge(E edge, Collection<? extends V> vertices, EdgeType edge_type)
boolean	addEdge(E edge, Pair<? extends V> endpoints, EdgeType edgeType) Adds edge to this graph with the specified endpoints and EdgeType.
boolean	addEdge(E e, V parent, V child)
boolean	addEdge(E e, V v1, V v2, EdgeType edge_type)
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	addVertex(V vertex)
boolean	containsEdge(E edge)
boolean	containsVertex(V vertex)
E	findEdge(V v1, V v2)
Collection<E>	findEdgeSet(V v1, V v2)
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)
E	getChildEdge(V vertex, int index)
Collection<E>	getChildEdges(V vertex)
Collection<V>	getChildren(V vertex) Returns an ordered list of vertex's child vertices.
int	getDepth(V vertex)
V	getDest(E directed_edge)
int	getEdgeCount()
Collection<E>	getEdges()
Pair<V>	getEndpoints(E edge)
static <V,E> com.google.common.base.Supplier<DirectedGraph<V,E>>	getFactory(int order)
int	getHeight() Returns the height of the tree, or -1 if the tree is empty.
int	getIncidentCount(E edge)
Collection<E>	getIncidentEdges(V vertex)
Collection<V>	getIncidentVertices(E edge)
Collection<E>	getInEdges(V vertex)
int	getNeighborCount(V vertex)
Collection<V>	getNeighbors(V vertex)
V	getOpposite(V vertex, E edge)
Collection<E>	getOutEdges(V vertex)
V	getParent(V vertex)
E	getParentEdge(V vertex)
int	getPredecessorCount(V vertex)
Collection<V>	getPredecessors(V vertex)
V	getRoot()
V	getSource(E directed_edge)
int	getSuccessorCount(V vertex)
Collection<V>	getSuccessors(V vertex)
Collection<Tree<V,E>>	getTrees()
int	getVertexCount()
Collection<V>	getVertices()
int	inDegree(V vertex)
boolean	isDest(V vertex, E edge)
boolean	isIncident(V vertex, E edge)
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)
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)
boolean	isSuccessor(V v1, V v2)
int	outDegree(V vertex)
boolean	removeEdge(E edge)
boolean	removeVertex(V vertex)

Methods inherited from class edu.uci.ics.jung.graph.AbstractTypedGraph

getDefaultEdgeType, getEdgeCount, getEdges, getEdgeType, hasEqualEdgeType, validateEdgeType

Methods inherited from class edu.uci.ics.jung.graph.AbstractGraph

addEdge, addEdge, degree, getValidatedEndpoints, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface edu.uci.ics.jung.graph.Hypergraph

addEdge, degree, getDefaultEdgeType, getEdgeCount, getEdges, getEdgeType

Field Detail

edge_vpairs

protected Map<E,Pair<V>> edge_vpairs

vertex_data

protected Map<V,OrderedKAryTree.VertexData> vertex_data

height

protected int height

root

protected V root

order

protected int order

Constructor Detail

OrderedKAryTree

public OrderedKAryTree(int order)

Creates a new instance with the specified order (maximum number of children).

Parameters:

order - the maximum number of children ("k") that any vertex can have

Method Detail

getFactory

public static <V,E> com.google.common.base.Supplier<DirectedGraph<V,E>> getFactory(int order)

Type Parameters:

V - the vertex type for the graph Supplier

E - the edge type for the graph Supplier

Parameters:

order - the maximum number of children ("k") that any vertex can have

Returns:

a Supplier that creates an instance of this graph type.

getChildCount

public int getChildCount(V vertex)

Specified by:

getChildCount in interface Forest<V,E>

Parameters:

vertex - the vertex whose number of children is to be returned

Returns:

the number of children that vertex has

See Also:

Forest.getChildCount(java.lang.Object)

getChildEdge

public E getChildEdge(V vertex,
                      int index)

Parameters:

vertex - the vertex whose child edge is to be returned

index - the index of the edge to be returned

Returns:

the child edge of vertex at index index, that is, its ith child edge.

getChildEdges

public Collection<E> getChildEdges(V vertex)

Specified by:

getChildEdges in interface Forest<V,E>

See Also:

Forest.getChildEdges(java.lang.Object)

getChildren

public Collection<V> getChildren(V vertex)

Returns an ordered list of 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.

Specified by:

getChildren in interface Forest<V,E>

See Also:

Forest.getChildren(java.lang.Object)

getDepth

public int getDepth(V vertex)

Specified by:

getDepth in interface Tree<V,E>

Returns:

the depth of the vertex in this tree, or -1 if the vertex is not present in this tree

See Also:

Tree.getDepth(java.lang.Object)

getHeight

public int getHeight()

Returns the height of the tree, or -1 if the tree is empty.

Specified by:

getHeight in interface Tree<V,E>

See Also:

Tree.getHeight()

getParent

public V getParent(V vertex)

Specified by:

getParent in interface Forest<V,E>

See Also:

Forest.getParent(java.lang.Object)

getParentEdge

public E getParentEdge(V vertex)

Specified by:

getParentEdge in interface Forest<V,E>

See Also:

Forest.getParentEdge(java.lang.Object)

getRoot

public V getRoot()

Specified by:

getRoot in interface Tree<V,E>

See Also:

Tree.getRoot()

getTrees

public Collection<Tree<V,E>> getTrees()

Specified by:

getTrees in interface Forest<V,E>

See Also:

Forest.getTrees()

addEdge

public 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. 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.

Parameters:

e - the edge to add

parent - the source of the edge to be added

child - the destination of the edge to be added

index - the position at which e is to be added as a child of parent

Returns:

true if the graph has been modified

See Also:

Graph.addEdge(java.lang.Object, java.lang.Object, java.lang.Object)

addEdge

public boolean addEdge(E e,
                       V parent,
                       V child)

Specified by:

addEdge in interface Graph<V,E>

Overrides:

addEdge in class AbstractGraph<V,E>

See Also:

Graph.addEdge(java.lang.Object, java.lang.Object, java.lang.Object)

addEdge

public boolean addEdge(E e,
                       V v1,
                       V v2,
                       EdgeType edge_type)

Specified by:

addEdge in interface Graph<V,E>

Overrides:

addEdge in class AbstractGraph<V,E>

See Also:

Graph.addEdge(java.lang.Object, java.lang.Object, java.lang.Object, edu.uci.ics.jung.graph.util.EdgeType)

getDest

public V getDest(E directed_edge)

Specified by:

getDest in interface Graph<V,E>

Specified by:

getDest in interface Hypergraph<V,E>

See Also:

Graph.getDest(java.lang.Object)

getEndpoints

public Pair<V> getEndpoints(E edge)

Specified by:

getEndpoints in interface Graph<V,E>

See Also:

Graph.getEndpoints(java.lang.Object)

getInEdges

public Collection<E> getInEdges(V vertex)

Specified by:

getInEdges in interface Graph<V,E>

Specified by:

getInEdges in interface Hypergraph<V,E>

See Also:

Graph.getInEdges(java.lang.Object)

getOpposite

public V getOpposite(V vertex,
                     E edge)

Specified by:

getOpposite in interface Graph<V,E>

Overrides:

getOpposite in class AbstractGraph<V,E>

See Also:

Graph.getOpposite(java.lang.Object, java.lang.Object)

getOutEdges

public Collection<E> getOutEdges(V vertex)

Specified by:

getOutEdges in interface Graph<V,E>

Specified by:

getOutEdges in interface Hypergraph<V,E>

See Also:

Graph.getOutEdges(java.lang.Object)

getPredecessorCount

public int getPredecessorCount(V vertex)

Specified by:

getPredecessorCount in interface Graph<V,E>

Overrides:

getPredecessorCount in class AbstractGraph<V,E>

Returns:

0 if vertex is the root, -1 if the vertex is not an element of this tree, and 1 otherwise

See Also:

Graph.getPredecessorCount(java.lang.Object)

getPredecessors

public Collection<V> getPredecessors(V vertex)

Specified by:

getPredecessors in interface Graph<V,E>

Specified by:

getPredecessors in interface Hypergraph<V,E>

See Also:

Graph.getPredecessors(java.lang.Object)

getSource

public V getSource(E directed_edge)

Specified by:

getSource in interface Graph<V,E>

Specified by:

getSource in interface Hypergraph<V,E>

See Also:

Graph.getSource(java.lang.Object)

getSuccessorCount

public int getSuccessorCount(V vertex)

Specified by:

getSuccessorCount in interface Graph<V,E>

Overrides:

getSuccessorCount in class AbstractGraph<V,E>

See Also:

Graph.getSuccessorCount(java.lang.Object)

getSuccessors

public Collection<V> getSuccessors(V vertex)

Specified by:

getSuccessors in interface Graph<V,E>

Specified by:

getSuccessors in interface Hypergraph<V,E>

See Also:

Graph.getSuccessors(java.lang.Object)

inDegree

public int inDegree(V vertex)

Specified by:

inDegree in interface Graph<V,E>

Specified by:

inDegree in interface Hypergraph<V,E>

Overrides:

inDegree in class AbstractGraph<V,E>

See Also:

Graph.inDegree(java.lang.Object)

isDest

public boolean isDest(V vertex,
                      E edge)

Specified by:

isDest in interface Graph<V,E>

See Also:

Graph.isDest(java.lang.Object, java.lang.Object)

isLeaf

public boolean isLeaf(V vertex)

Returns true if vertex is a leaf of this tree, i.e., if it has no children.

Parameters:

vertex - the vertex to be queried

Returns:

true if outDegree(vertex)==0

isPredecessor

public boolean isPredecessor(V v1,
                             V v2)

Returns true iff v1 is the parent of v2. Note that if v2 is the root and v1 is null, this method returns true.

Specified by:

isPredecessor in interface Graph<V,E>

Overrides:

isPredecessor in class AbstractGraph<V,E>

See Also:

Graph.isPredecessor(java.lang.Object, java.lang.Object)

isRoot

public boolean isRoot(V vertex)

Returns true if vertex is a leaf of this tree, i.e., if it has no children.

Parameters:

vertex - the vertex to be queried

Returns:

true if outDegree(vertex)==0

isSource

public boolean isSource(V vertex,
                        E edge)

Specified by:

isSource in interface Graph<V,E>

See Also:

Graph.isSource(java.lang.Object, java.lang.Object)

isSuccessor

public boolean isSuccessor(V v1,
                           V v2)

Specified by:

isSuccessor in interface Graph<V,E>

Overrides:

isSuccessor in class AbstractGraph<V,E>

See Also:

Graph.isSuccessor(java.lang.Object, java.lang.Object)

outDegree

public int outDegree(V vertex)

Specified by:

outDegree in interface Graph<V,E>

Specified by:

outDegree in interface Hypergraph<V,E>

Overrides:

outDegree in class AbstractGraph<V,E>

See Also:

Graph.outDegree(java.lang.Object)

addEdge

public boolean addEdge(E edge,
                       Collection<? extends V> vertices,
                       EdgeType edge_type)

Specified by:

addEdge in interface Hypergraph<V,E>

Overrides:

addEdge in class AbstractGraph<V,E>

See Also:

Hypergraph.addEdge(java.lang.Object, java.util.Collection)

addVertex

public boolean addVertex(V vertex)

Specified by:

addVertex in interface Hypergraph<V,E>

See Also:

Hypergraph.addVertex(java.lang.Object)

isIncident

public boolean isIncident(V vertex,
                          E edge)

Specified by:

isIncident in interface Hypergraph<V,E>

Overrides:

isIncident in class AbstractGraph<V,E>

See Also:

Hypergraph.isIncident(java.lang.Object, java.lang.Object)

isNeighbor

public boolean isNeighbor(V v1,
                          V v2)

Specified by:

isNeighbor in interface Hypergraph<V,E>

Overrides:

isNeighbor in class AbstractGraph<V,E>

See Also:

Hypergraph.isNeighbor(java.lang.Object, java.lang.Object)

containsEdge

public boolean containsEdge(E edge)

Specified by:

containsEdge in interface Hypergraph<V,E>

See Also:

Hypergraph.containsEdge(java.lang.Object)

containsVertex

public boolean containsVertex(V vertex)

Specified by:

containsVertex in interface Hypergraph<V,E>

See Also:

Hypergraph.containsVertex(java.lang.Object)

findEdge

public E findEdge(V v1,
                  V v2)

Specified by:

findEdge in interface Hypergraph<V,E>

Overrides:

findEdge in class AbstractGraph<V,E>

See Also:

Hypergraph.findEdge(java.lang.Object, java.lang.Object)

findEdgeSet

public Collection<E> findEdgeSet(V v1,
                                 V v2)

Specified by:

findEdgeSet in interface Hypergraph<V,E>

Overrides:

findEdgeSet in class AbstractGraph<V,E>

See Also:

Hypergraph.findEdgeSet(java.lang.Object, java.lang.Object)

getChild

public 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.

Parameters:

vertex - the vertex to query

index - the index of the child to return

Returns:

the child of vertex at position index in this tree, or null if it has no child at that position

Throws:

ArrayIndexOutOfBoundsException - if index is not in the range [0, order-1]

getEdgeCount

public int getEdgeCount()

Specified by:

getEdgeCount in interface Hypergraph<V,E>

See Also:

Hypergraph.getEdgeCount()

getEdges

public Collection<E> getEdges()

Specified by:

getEdges in interface Hypergraph<V,E>

See Also:

Hypergraph.getEdges()

getIncidentCount

public int getIncidentCount(E edge)

Specified by:

getIncidentCount in interface Hypergraph<V,E>

Overrides:

getIncidentCount in class AbstractGraph<V,E>

See Also:

Hypergraph.getIncidentCount(java.lang.Object)

getIncidentEdges

public Collection<E> getIncidentEdges(V vertex)

Specified by:

getIncidentEdges in interface Hypergraph<V,E>

See Also:

Hypergraph.getIncidentEdges(java.lang.Object)

getIncidentVertices

public Collection<V> getIncidentVertices(E edge)

Specified by:

getIncidentVertices in interface Hypergraph<V,E>

Overrides:

getIncidentVertices in class AbstractGraph<V,E>

See Also:

Hypergraph.getIncidentVertices(java.lang.Object)

getNeighborCount

public int getNeighborCount(V vertex)

Specified by:

getNeighborCount in interface Hypergraph<V,E>

Overrides:

getNeighborCount in class AbstractGraph<V,E>

See Also:

Hypergraph.getNeighborCount(java.lang.Object)

getNeighbors

public Collection<V> getNeighbors(V vertex)

Specified by:

getNeighbors in interface Hypergraph<V,E>

See Also:

Hypergraph.getNeighbors(java.lang.Object)

getVertexCount

public int getVertexCount()

Specified by:

getVertexCount in interface Hypergraph<V,E>

See Also:

Hypergraph.getVertexCount()

getVertices

public Collection<V> getVertices()

Specified by:

getVertices in interface Hypergraph<V,E>

See Also:

Hypergraph.getVertices()

removeEdge

public boolean removeEdge(E edge)

Specified by:

removeEdge in interface Hypergraph<V,E>

See Also:

Hypergraph.removeEdge(java.lang.Object)

removeVertex

public boolean removeVertex(V vertex)

Specified by:

removeVertex in interface Hypergraph<V,E>

See Also:

Hypergraph.removeVertex(java.lang.Object)

addEdge

public boolean addEdge(E edge,
                       Pair<? extends V> endpoints,
                       EdgeType edgeType)

Description copied from class: AbstractGraph

Adds edge to this graph with the specified endpoints and EdgeType.

Specified by:

addEdge in class AbstractGraph<V,E>

Parameters:

edge - the edge to be added

endpoints - the endpoints to be connected to this edge

edgeType - the type of edge to add

Returns:

true iff the graph was modified as a result of this call