components.binarytree

Interface BinaryTreeKernel<T>

Type Parameters:

T -

All Superinterfaces:

Standard<BinaryTree<T>>

All Known Subinterfaces:

BinaryTree<T>

All Known Implementing Classes:

BinaryTreeNL, BinaryTreeSecondary

public interface BinaryTreeKernel<T>
extends Standard<BinaryTree<T>>

BinaryTree kernel component containing method headers and contracts for all methods that will directly interact with the data representations of all BinaryTree implementations. All sub-interface methods should use only these methods to perform operations on the BinaryTree.

Author:

Matthew Shoemaker

Method Summary

Modifier and Type	Method and Description
void	build(T root, BinaryTree<T> left, BinaryTree<T> right) Builds this into a Binary Tree with root as the root of the tree, left as the left subtree of this, and right as the right subtree of this.
int	height() Reports the height of this.
BinaryTree<T>	leftSubtree() Removes the left subtree from this and returns it.
BinaryTree<T>	rightSubtree() Removes the right subtree from this and returns it.
T	root() Returns a reference to the root of this.
int	size() Reports the number of nodes int this.

Methods inherited from interface components.standard.Standard

clear, newInstance, transferFrom

Method Detail

build

void build(T root,
           BinaryTree<T> left,
           BinaryTree<T> right)

Builds this into a Binary Tree with root as the root of the tree, left as the left subtree of this, and right as the right subtree of this.

Parameters:

root - the new root of this

left - the new left subtree of this

right - the new right subtree of this

Requires:

 [left is not null] and
 [right is not null] and
 [left != right] and
 [left != this] and
 [right != this]
 

Ensures:

this = [binary tree with root at its root node, left as the left subtree of this, and right as the right subtree of this]

Replaces:

this

leftSubtree

BinaryTree<T> leftSubtree()

Removes the left subtree from this and returns it.

Returns:

this.left

Clears:

#this.left

Ensures:

leftSubtree = #this.left

rightSubtree

BinaryTree<T> rightSubtree()

Removes the right subtree from this and returns it.

Returns:

this.right

Clears:

#this.right

Ensures:

rightSubtree = #this.right

root

T root()

Returns a reference to the root of this.

Returns:

this.root

Requires:

this.size > 0

Ensures:

root = this.root

size

int size()

Reports the number of nodes int this.

Returns:

number of nodes in this

Ensures:

size = [number of nodes in this]

height

int height()

Reports the height of this.

Returns:

the height of this

Ensures:

height = [height of this]