net.junaraki.libtree

Class BinaryTree<E>

java.lang.Object

java.util.AbstractCollection<E>

net.junaraki.libtree.AbstractTree<E>

net.junaraki.libtree.OrderedTree<E>

net.junaraki.libtree.BinaryTree<E>

Type Parameters:

E - the type of elements in this tree

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, Tree<E>

public class BinaryTree<E>
extends OrderedTree<E>

This class implements a binary tree. A binary tree is an ordered tree in which each node has at most two children, referred to as the left child and the right child.

Author:

Jun Araki

Field Summary

Fields inherited from class net.junaraki.libtree.AbstractTree

PAREN_END, PAREN_START

Constructor Summary

Constructors

Constructor and Description
BinaryTree() Public constructor.
BinaryTree(E element) Public constructor.

Method Summary

Modifier and Type	Method and Description
void	add(BinaryTree<E> child) Adds the given child to this node.
void	addChild(BinaryTree<E> child) Adds the given child to this node.
void	addChild(E element) Adds a child with the given element to this node.
BinaryTree<E>	find(E element) Finds a node of the first occurrence of the given element in this tree.
BinaryTree<E>	findChild(E element) Finds a child of the first occurrence of the given element in this node.
java.util.List<BinaryTree<E>>	getBinaryTreeNodes() Returns a list of all nodes of the type BinaryTree<E> in this tree.
BinaryTree<E>	getChildAt(int index) Returns the child of this node at the given index.
BinaryTree<E>	getDeepestLeftLeaf() Returns the deepest left leaf node of this tree.
BinaryTree<E>	getDeepestRightLeaf() Returns the deepest right leaf node of this tree.
BinaryTree<E>	getLeftChild() Returns the left child of this node.
BinaryTree<E>	getParent() Returns the parent of this node.
BinaryTree<E>	getRightChild() Returns the right child of this node.
boolean	hasLeftChild() Returns true if this node has a left child.
boolean	hasLeftChild(BinaryTree<E> child) Returns true if this node has the given left child.
boolean	hasLeftChild(E element) Returns true if this node has a left child with the given element.
boolean	hasRightChild() Returns true if this node has a right child.
boolean	hasRightChild(BinaryTree<E> child) Returns true if this node has the given right child.
boolean	hasRightChild(E element) Returns true if this node has a right child with the given element.
int	numChildren() Returns the number of children of this node.
void	removeLeftChild() Removes the left child of this node.
void	removeRightChild() Removes the right child of this node.
void	setLeftChild(BinaryTree<E> child) Sets the given left child to this node.
void	setLeftChild(E element) Sets the left child of this child with the given element.
void	setParent(BinaryTree<E> parent) Sets the given parent to this node.
void	setRightChild(BinaryTree<E> child) Sets the given right child to this node.
void	setRightChild(E element) Sets the right child of this node with the given element.

Methods inherited from class net.junaraki.libtree.OrderedTree

add, addChild, binarize, equals, getAncestorElements, getAncestors, getChildren, getElements, getFirstChild, getLastChild, getLeaves, getNodes, getOrderedTreeNodes, getRoot, getSiblingElements, getSiblings, getSubtrees, hasChild, hasChild, hashCode, isFirstChild, isLastChild, numSiblings, remove, removeChild, removeChild, removeChildAt, removeChildren, setChildAt, setParent, subsumes, toNewick, toNewick, toString, traverse, traverseLevelOrder, traverseNodes, traverseNodesLevelOrder, traverseNodesPostOrder, traverseNodesPreOrder, traversePostOrder, traversePreOrder

Methods inherited from class net.junaraki.libtree.AbstractTree

add, degree, degree, depth, depth, getElement, getLeafElements, hasAncestor, hasAncestor, hasChild, hasDescendant, hasDescendant, hasElement, hasElement, hasParent, hasParent, hasParent, isBalanced, isLabeled, isLabeledTree, isLeaf, isRoot, iterator, numLeaves, removeChildren, setElement, size, yield

Methods inherited from class java.util.AbstractCollection

addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

addAll, clear, contains, containsAll, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

BinaryTree

public BinaryTree()

Public constructor.

BinaryTree

public BinaryTree(E element)

Public constructor.

Parameters:

element - an element of this node

Method Detail

find

public BinaryTree<E> find(E element)

Finds a node of the first occurrence of the given element in this tree.

Specified by:

find in interface Tree<E>

Overrides:

find in class OrderedTree<E>

Parameters:

element - an element to be found in this tree, if present

Returns:

a node of the first occurrence of the given element in this tree

findChild

public BinaryTree<E> findChild(E element)

Finds a child of the first occurrence of the given element in this node.

Specified by:

findChild in interface Tree<E>

Overrides:

findChild in class OrderedTree<E>

Parameters:

element - an element to be found in the children of this node, if present

Returns:

a child of the first occurrence of the given element in this node

getParent

public BinaryTree<E> getParent()

Returns the parent of this node.

Specified by:

getParent in interface Tree<E>

Overrides:

getParent in class OrderedTree<E>

Returns:

the parent of this node

setParent

public void setParent(BinaryTree<E> parent)

Sets the given parent to this node.

Parameters:

parent - a parent that will be set to this node

getChildAt

public BinaryTree<E> getChildAt(int index)

Returns the child of this node at the given index.

Overrides:

getChildAt in class OrderedTree<E>

Parameters:

index - an index of the element to return

Returns:

the child of this node at the given index

getLeftChild

public BinaryTree<E> getLeftChild()

Returns the left child of this node.

Returns:

the left child of this node

getDeepestLeftLeaf

public BinaryTree<E> getDeepestLeftLeaf()

Returns the deepest left leaf node of this tree.

Returns:

the deepest left leaf node of this tree

setLeftChild

public void setLeftChild(E element)

Sets the left child of this child with the given element.

Parameters:

element - an element to be set to the left child

setLeftChild

public void setLeftChild(BinaryTree<E> child)

Sets the given left child to this node.

Parameters:

child - a child node to be set as the left child

getRightChild

public BinaryTree<E> getRightChild()

Returns the right child of this node.

Returns:

the right child of this node

getDeepestRightLeaf

public BinaryTree<E> getDeepestRightLeaf()

Returns the deepest right leaf node of this tree.

Returns:

the deepest right leaf node of this tree

setRightChild

public void setRightChild(E element)

Sets the right child of this node with the given element.

Parameters:

element - an element to be set to the right child

setRightChild

public void setRightChild(BinaryTree<E> child)

Sets the given right child to this node.

Parameters:

child - a child node to be set as the right child

numChildren

public int numChildren()

Returns the number of children of this node.

Specified by:

numChildren in interface Tree<E>

Overrides:

numChildren in class OrderedTree<E>

Returns:

the number of children of this node

hasLeftChild

public boolean hasLeftChild()

Returns true if this node has a left child.

Returns:

true if this node has a left child; false otherwise

hasLeftChild

public boolean hasLeftChild(E element)

Returns true if this node has a left child with the given element.

Parameters:

element - an element whose presence in the left child of this node will be tested

Returns:

true if this node has a left child with the given element; false otherwise

hasLeftChild

public boolean hasLeftChild(BinaryTree<E> child)

Returns true if this node has the given left child.

Parameters:

child - a node whose presence in the left child of this node will be tested

Returns:

true if this node has the given left child; false otherwise

hasRightChild

public boolean hasRightChild()

Returns true if this node has a right child.

Returns:

true if this node has a right child; false otherwise

hasRightChild

public boolean hasRightChild(E element)

Returns true if this node has a right child with the given element.

Parameters:

element - an element whose presence in the right child of this node will be tested

Returns:

true if this node has a right child with the given element; false otherwise

hasRightChild

public boolean hasRightChild(BinaryTree<E> child)

Returns true if this node has the given right child.

Parameters:

child - a node whose presence in the right child of this node will be tested

Returns:

true if this node has the given right child; false otherwise

add

public void add(BinaryTree<E> child)

Adds the given child to this node.

Parameters:

child - a child that will be added to this node

addChild

public void addChild(BinaryTree<E> child)

Adds the given child to this node.

Parameters:

child - a child that will be added to this node

addChild

public void addChild(E element)

Adds a child with the given element to this node.

Specified by:

addChild in interface Tree<E>

Overrides:

addChild in class OrderedTree<E>

Parameters:

element - an element that will be added to the children of this node

getBinaryTreeNodes

public java.util.List<BinaryTree<E>> getBinaryTreeNodes()

Returns a list of all nodes of the type BinaryTree<E> in this tree.

Returns:

a list of all nodes of the type BinaryTree<E> in this tree

removeLeftChild

public void removeLeftChild()

Removes the left child of this node.

removeRightChild

public void removeRightChild()

Removes the right child of this node.