indexing
	description: "[
		Binary search trees; left child item is less than current item,
		right child item is greater
	]"
	status: "See notice at end of class"
	names: binary_search_tree, tree
	representation: recursive, array
	access: cursor, membership
	contents: generic
	date: "$Date$"
	revision: "$Revision$"

class interface
	BINARY_SEARCH_TREE [G -> COMPARABLE]

create

	make (v: like item)
			-- Create single node with item v.
		require
			item_exists: v /= void
		ensure
			node_item: item = v
			no_child: (left_child = void) and (right_child = void)

feature -- Initialization

	make (v: like item)
			-- Create single node with item v.
		require
			item_exists: v /= void
		ensure
			node_item: item = v
			no_child: (left_child = void) and (right_child = void)

	bt_make (v: like item)
			-- Create a root node with value v.
			-- (from BINARY_TREE)
		ensure -- from BINARY_TREE
			is_root: is_root
			is_leaf: is_leaf

feature -- Access

	child: like parent
			-- Child at cursor position
			-- (from BINARY_TREE)
		require -- from TREE
			readable: readable_child

	child_cursor: CURSOR
			-- Current cursor position
			-- (from BINARY_TREE)

	child_index: INTEGER
			-- Index of cursor position
			-- (from BINARY_TREE)

	child_item: like item
			-- Item in current child node
			-- (from TREE)
		require -- from TREE
			readable: child_readable

	first_child: like parent
			-- Left child
			-- (from BINARY_TREE)
		require -- from TREE
			is_not_leaf: not is_leaf

	has (v: like item): BOOLEAN
			-- Does tree contain a node whose item
			-- is equal to v (object comparison)?
		require -- from  CONTAINER
			True
		require else
			argument_not_void: v /= void
		ensure -- from CONTAINER
			not_found_in_empty: Result implies not is_empty

	item: G
			-- Content of cell.
			-- (from CELL)

	last_child: like parent
			-- Right child
			-- (from BINARY_TREE)
		require -- from TREE
			is_not_leaf: not is_leaf

	left_child: like parent
			-- Left child, if any
			-- (from BINARY_TREE)

	left_item: like item
			-- Value of left child
			-- (from BINARY_TREE)
		require -- from BINARY_TREE
			has_left: left_child /= void

	left_sibling: like parent
			-- Left neighbor, if any
			-- (from BINARY_TREE)
		require -- from TREE
			is_not_root: not is_root
		ensure -- from TREE
			is_sibling: Result /= void implies is_sibling (Result)
			right_is_current: (Result /= void) implies (Result.right_sibling = Current)

	parent: BINARY_SEARCH_TREE [G]
			-- Parent of current node

	right_child: like parent
			-- Right child, if any
			-- (from BINARY_TREE)

	right_item: like item
			-- Value of right child
			-- (from BINARY_TREE)
		require -- from BINARY_TREE
			has_right: right_child /= void

	right_sibling: like parent
			-- Right neighbor, if any
			-- (from BINARY_TREE)
		require -- from TREE
			is_not_root: not is_root
		ensure -- from TREE
			is_sibling: Result /= void implies is_sibling (Result)
			left_is_current: (Result /= void) implies (Result.left_sibling = Current)

feature -- Measurement

	arity: INTEGER
			-- Number of children
			-- (from BINARY_TREE)
		ensure then -- from BINARY_TREE
			valid_arity: Result <= 2

	count: INTEGER
			-- Number of items
			-- (from TREE)

	max: like item
			-- Maximum item in tree
		ensure
			maximum_present: has (Result)

	min: like item
			-- Minimum item in tree
		ensure
			minimum_present: has (Result)

feature -- Comparison

	is_equal (other: like Current): BOOLEAN
			-- Does other contain the same elements?
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from TREE)
		require -- from ANY
			other_not_void: other /= void
		ensure -- from ANY
			symmetric: Result implies other.is_equal (Current)
			consistent: standard_is_equal (other) implies Result

feature -- Status report

	changeable_comparison_criterion: BOOLEAN
			-- May object_comparison be changed?
			-- (Answer: yes by default.)
			-- (from CONTAINER)

	child_after: BOOLEAN
			-- Is there no valid child position to the right of cursor?
			-- (from BINARY_TREE)

	child_before: BOOLEAN
			-- Is there no valid child position to the left of cursor?
			-- (from TREE)

	child_isfirst: BOOLEAN
			-- Is cursor under first child?
			-- (from TREE)
		ensure -- from TREE
			not_is_leaf: Result implies not is_leaf

	child_islast: BOOLEAN
			-- Is cursor under last child?
			-- (from TREE)
		ensure -- from TREE
			not_is_leaf: Result implies not is_leaf

	child_off: BOOLEAN
			-- Is there no current child?
			-- (from TREE)

	child_readable: BOOLEAN
			-- Is there a current child_item to be read?
			-- (from TREE)

	child_writable: BOOLEAN
			-- Is there a current child_item that may be modified?
			-- (from TREE)

	has_both: BOOLEAN
			-- Has current node two children?
			-- (from BINARY_TREE)
		ensure -- from BINARY_TREE
			Result = (has_left and has_right)

	has_left: BOOLEAN
			-- Has current node a left child?
			-- (from BINARY_TREE)
		ensure -- from BINARY_TREE
			Result = (left_child /= void)

	has_none: BOOLEAN
			-- Are there no children?
			-- Was declared in BINARY_TREE as synonym of is_leaf.
			-- (from BINARY_TREE)

	has_right: BOOLEAN
			-- Has current node a right child?
			-- (from BINARY_TREE)
		ensure -- from BINARY_TREE
			Result = (right_child /= void)

	is_empty: BOOLEAN
			-- Is structure empty of items?
			-- (from TREE)

	is_leaf: BOOLEAN
			-- Are there no children?
			-- Was declared in BINARY_TREE as synonym of has_none.
			-- (from BINARY_TREE)

	is_root: BOOLEAN
			-- Is there no parent?
			-- (from TREE)

	is_sibling (other: like parent): BOOLEAN
			-- Are current node and other siblings?
			-- (from TREE)
		require -- from TREE
			other_exists: other /= void
		ensure -- from TREE
			not_root: Result implies not is_root
			other_not_root: Result implies not other.is_root
			same_parent: Result = not is_root and other.parent = parent

	object_comparison: BOOLEAN
			-- Must search operations use equal rather than =
			-- for comparing references? (Default: no, use =.)
			-- (from CONTAINER)

	Readable: BOOLEAN is True
			-- (from TREE)

	readable_child: BOOLEAN
			-- Is there a current child to be read?
			-- (from TREE)

	sorted: BOOLEAN
			-- Is tree sorted?

	sorted_and_less (i: like item): BOOLEAN
			-- Is tree sorted and all its elements less then i

	valid_cursor_index (i: INTEGER): BOOLEAN
			-- Is i correctly bounded for cursor movement?
			-- (from TREE)
		ensure -- from TREE
			valid_cursor_index_definition: Result = (i >= 0) and (i <= child_capacity + 1)

	Writable: BOOLEAN is True
			-- Is there a current item that may be modified?
			-- (from TREE)

	writable_child: BOOLEAN
			-- Is there a current child that may be modified?
			-- (from TREE)

feature -- Status setting

	compare_objects
			-- Ensure that future search operations will use equal
			-- rather than = for comparing references.
			-- (from CONTAINER)
		require -- from CONTAINER
			changeable_comparison_criterion
		ensure -- from CONTAINER
			object_comparison

	compare_references
			-- Ensure that future search operations will use =
			-- rather than equal for comparing references.
			-- (from CONTAINER)
		require -- from CONTAINER
			changeable_comparison_criterion
		ensure -- from CONTAINER
			reference_comparison: not object_comparison

feature -- Cursor movement

	child_back
			-- Move cursor to previous child.
			-- (from BINARY_TREE)

	child_finish
			-- Move cursor to last child.
			-- (from BINARY_TREE)
		ensure then -- from TREE
			is_last_child: not is_leaf implies child_islast

	child_forth
			-- Move cursor to next child.
			-- (from BINARY_TREE)

	child_go_i_th (i: INTEGER)
			-- Move cursor to i-th child.
			-- (from BINARY_TREE)
		require else -- from TREE
			valid_cursor_index: valid_cursor_index (i)
		ensure then -- from TREE
			position: child_index = i

	child_go_to (p: ARRAYED_LIST_CURSOR)
			-- Move cursor to child remembered by p.
			-- (from BINARY_TREE)

	child_start
			-- Move to first child.
			-- (from BINARY_TREE)
		ensure then -- from TREE
			is_first_child: not is_leaf implies child_isfirst

	i_infix
			-- Apply node_action to every node's item
			-- in tree, using infix order.

	node_action (v: like item)
			-- Operation on node item,
			-- to be defined by descendant classes.
			-- Here it is defined as an empty operation.
			-- Redefine this procedure in descendant classes if useful
			-- operations are to be performed during traversals.

	postorder
			-- Apply node_action to every node's item
			-- in tree, using post-order.

	preorder
			-- Apply node_action to every node's item
			-- in tree, using pre-order.

feature -- Element change

	child_put (v: like item)
			-- Put v at current child position.
			-- Was declared in BINARY_TREE as synonym of child_replace.
			-- (from BINARY_TREE)
		require -- from TREE
			child_writable: child_writable
		ensure -- from TREE
			item_inserted: child_item = v

	child_replace (v: like item)
			-- Put v at current child position.
			-- Was declared in BINARY_TREE as synonym of child_put.
			-- (from BINARY_TREE)
		require -- from TREE
			child_writable: child_writable
		ensure -- from TREE
			item_inserted: child_item = v

	extend (v: like item)
			-- Put v at proper position in tree
			-- (unless v exists already).
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- Was declared in BINARY_SEARCH_TREE as synonym of put.
		require
			new_item_exists: v /= void
		ensure
			item_inserted: has (v)

	fill (other: TREE [G])
			-- Fill with as many items of other as possible.
			-- The representations of other and current node
			-- need not be the same.
			-- (from TREE)

	put (v: like item)
			-- Put v at proper position in tree
			-- (unless v exists already).
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- Was declared in BINARY_SEARCH_TREE as synonym of extend.
		require
			new_item_exists: v /= void
		ensure
			item_inserted: has (v)

	bt_put (v: like item)
			-- Make v the cell's item.
			-- Was declared in CELL as synonym of replace.
			-- (from CELL)
		require -- from TREE
			is_writable: writable
		ensure -- from TREE
			item_inserted: item = v
		ensure -- from CELL
			item_inserted: item = v

	put_child (n: like parent)
			-- Put n at current child position.
			-- Was declared in BINARY_TREE as synonym of replace_child.
			-- (from BINARY_TREE)

	replace (v: like item)
			-- Make v the cell's item.
			-- Was declared in CELL as synonym of put.
			-- (from CELL)
		require -- from TREE
			is_writable: writable
		ensure -- from TREE
			item_inserted: item = v
		ensure -- from CELL
			item_inserted: item = v

	replace_child (n: like parent)
			-- Put n at current child position.
			-- Was declared in BINARY_TREE as synonym of put_child.
			-- (from BINARY_TREE)
		require -- from TREE
			writable_child: writable_child
			was_root: n.is_root
		ensure -- from TREE
			child_replaced: child = n

	sprout
			-- Make current node a root.
			-- (from TREE)

feature -- Removal

	child_remove
			-- Remove current child.
			-- (from BINARY_TREE)

	prune (n: like parent)
			-- Prune n from child nodes.
			-- (from BINARY_TREE)
		require -- from TREE
			is_child: n.parent = Current
		ensure -- from TREE
			n_is_root: n.is_root

feature -- Transformation

	sort
			-- Sort tree.
		ensure
			is_sorted: sorted

feature -- Conversion

	binary_representation: BINARY_TREE [G]
			-- Convert to binary tree representation:
			-- first child becomes left child,
			-- right sibling becomes right child.
			-- (from TREE)
		ensure -- from TREE
			result_is_root: Result.is_root
			result_has_no_right_child: not Result.has_right

	linear_representation: LINEAR [G]
			-- Representation as a linear structure
			-- (from TREE)

feature -- Duplication

	copy (other: like Current)
			-- Copy contents from other.
			-- (from BINARY_TREE)
		require -- from ANY
			other_not_void: other /= void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: is_equal (other)

	duplicate (n: INTEGER): like Current
			-- Copy of sub-tree beginning at cursor position and
			-- having min (n, arity - child_index + 1)
			-- children.
			-- (from BINARY_TREE)
		require -- from TREE
			not_child_off: not child_off
			valid_sublist: n >= 0

	duplicate_all: like Current
			-- (from BINARY_TREE)

invariant

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)
		-- from BINARY_TREE
	tree_is_binary: child_capacity = 2
		-- from TREE
	leaf_definition: is_leaf = (arity = 0)
	child_off_definition: child_off = child_before or child_after
	child_before_definition: child_before = (child_index = 0)
	child_isfirst_definition: child_isfirst = (not is_leaf and child_index = 1)
	child_islast_definition: child_islast = (not is_leaf and child_index = child_capacity)
	child_after_definition: child_after = (child_index >= child_capacity + 1)
	child_consistency: child_readable implies child.parent = Current

indexing
	library: "[
			EiffelBase: Library of reusable components for Eiffel.
	]"
	status: "[
			Copyright 1986-2001 Interactive Software Engineering (ISE).
			For ISE customers the original versions are an ISE product
			covered by the ISE Eiffel license and support agreements.
	]"
	license: "[
			EiffelBase may now be used by anyone as FREE SOFTWARE to
			develop any product, public-domain or commercial, without
			payment to ISE, under the terms of the ISE Free Eiffel Library
			License (IFELL) at http://eiffel.com/products/base/license.html.
	]"
	source: "[
			Interactive Software Engineering Inc.
			ISE Building
			360 Storke Road, Goleta, CA 93117 USA
			Telephone 805-685-1006, Fax 805-685-6869
			Electronic mail <info@eiffel.com>
			Customer support http://support.eiffel.com
	]"
	info: "[
			For latest info see award-winning pages: http://eiffel.com
	]"

end -- class BINARY_SEARCH_TREE