components.binarytree

Interface BinaryTree<T>

Type Parameters:

T -

All Superinterfaces:

BinaryTreeKernel<T>, Standard<BinaryTree<T>>

All Known Implementing Classes:

BinaryTreeNL, BinaryTreeSecondary

public interface BinaryTree<T>
extends BinaryTreeKernel<T>

Additional functionality upon the bare-bones functionality afforded by the BinaryTreeKernel interface. All method implementations must, by design, use only the BinaryTreeKernel methods to perform operations on the component.

Author:

Matthew Shoemaker

Method Summary

Modifier and Type	Method and Description
boolean	contains(T node) Reports whether node is in this.
void	remove(T node) Searches this for node, and removes it from this.
T	replaceRoot(T replacement) Swaps #this.root with replacement and returns #this.root.

Methods inherited from interface components.binarytree.BinaryTreeKernel

build, height, leftSubtree, rightSubtree, root, size

Methods inherited from interface components.standard.Standard

clear, newInstance, transferFrom

Method Detail

replaceRoot

T replaceRoot(T replacement)

Swaps #this.root with replacement and returns #this.root.

Parameters:

replacement - new root of this

Returns:

#this.root

Updates:

this

Requires:

this.size > 0 and replacement is not null

Ensures:

this.root = replacement and replacement = #this.root

remove

void remove(T node)

Searches this for node, and removes it from this. The binary tree represented by this is restructured such that the left-most node of the right subtree of the binary tree rooted at node is moved to the root of that subtree. If there is no right subtree, then the right-most node of the left subtree of the binary tree rooted at node is moved to the root of that subtree. In the case that node is a leaf, it is simply removed.

Parameters:

node - node to be removed from this

Updates:

this

Requires:

[node is in this] and [node is not null]

Ensures:

[The binary tree represented by this is restructured such that the left-most node of the right subtree of the binary tree rooted at node is moved to the root of that subtree. If there is no right subtree, then the right-most node of the left subtree of the binary tree rooted at node is moved to the root of that subtree. In the case that node is a leaf, it is simply removed]

contains

boolean contains(T node)

Reports whether node is in this.

Parameters:

node - node to search for

Returns:

whether node is in this

Ensures:

contains = [node is in this]