indexing
	description: "Trees with a dynamically modifiable structure"
	names: dynamic_tree, tree
	representation: recursive
	access: cursor, membership
	contents: generic

deferred class interface
	DYNAMIC_TREE [G]

feature -- Access

	child: like parent
			-- Current child node
			-- (from TREE)
		require -- from TREE
			readable: readable_child

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

	child_index: INTEGER
			-- Index of current child
			-- (from TREE)
		ensure -- from TREE
			valid_index: Result >= 0 and Result <= arity + 1

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

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

	has (v: G): BOOLEAN
			-- Does subtree include v?
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from TREE)
		ensure -- from CONTAINER
			not_found_in_empty: Result implies not empty

	is_sibling (other: like parent): BOOLEAN
			-- Are current node and other siblings?
			-- (from TREE)
		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

	item: G
			-- Item in current node
			-- (from TREE)

	last_child: like first_child
			-- Right most child
			-- (from TREE)
		require -- from TREE
			is_not_leaf: not is_leaf

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

	parent: DYNAMIC_TREE [G]
			-- Parent of current node.

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

	arity: INTEGER
			-- Number of children
			-- (from TREE)

	count: INTEGER
			-- Number of items
			-- (from TREE)
	
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 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)

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

	Extendible: BOOLEAN is true
			-- May new items be added?

	is_leaf: BOOLEAN
			-- Are there no children?
			-- (from TREE)

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

	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)

	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 <= arity + 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 TREE)

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

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

	child_go_i_th (i: INTEGER)
			-- Move cursor to i-th child.
			-- (from TREE)
		require else -- from TREE
			valid_cursor_index: valid_cursor_index (i)
		ensure then -- from TREE
			position: child_index = i;
			is_before: (i = 0) implies child_before;
			is_after: (i = arity + 1) implies child_after

	child_go_to (p: CURSOR)
			-- Move cursor to position p.
			-- (from TREE)

	child_start
			-- Move cursor to first child.
			-- (from TREE)
		ensure then -- from TREE
			is_first_child: not is_leaf implies child_isfirst
	
feature -- Element change

	child_extend (v: like item)
			-- Add v to the list of children.
			-- Do not move child cursor.

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

	child_put_left (v: like item)
			-- Add v to the left of cursor position.
			-- Do not move child cursor.
		require
			not_child_before: not child_before

	child_put_right (v: like item)
			-- Add v to the right of cursor position.
			-- Do not move child cursor.
		require
			not_child_after: not child_after

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

	extend (v: like item)
			-- Add v as new child.

	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)

	merge_tree_after (other: like first_child)
			-- Merge children of other into current structure
			-- after cursor position. Do not move cursor.
			-- Make other a leaf.
		require
			not_child_off: not child_off;
			other_exists: (other /= void)
		ensure
			other_is_leaf: other.is_leaf

	merge_tree_before (other: like first_child)
			-- Merge children of other into current structure
			-- after cursor position. Do not move cursor.
			-- Make other a leaf.
		require
			not_child_off: not child_off;
			other_exists: (other /= void)
		ensure
			other_is_leaf: other.is_leaf

	prune (n: like parent)
			-- Remove n from the children
			-- (from TREE)
		require -- from TREE
			is_child: n.parent = Current
		ensure -- from TREE
			n_is_root: n.is_root

	put (v: like item)
			-- Replace element at cursor position by v.
			-- Was declared in TREE as synonym of put and replace.
			-- (from TREE)
		require -- from TREE
			is_writable: writable
		ensure -- from TREE
			item_inserted: item = v

	put_child (n: like parent)
			-- Add n to the list of children.
			-- Do not move child cursor.
		require else
			non_void_argument: n /= void

	put_child_left (n: like parent)
			-- Add n to the left of cursor position.
			-- Do not move cursor.
		require
			not_child_before: not child_before;
			non_void_argument: n /= void

	put_child_right (n: like parent)
			-- Add n to the right of cursor position.
			-- Do not move cursor.
		require
			not_child_after: not child_after;
			non_void_argument: n /= void

	replace (v: like item)
			-- Replace element at cursor position by v.
			-- Was declared in TREE as synonym of put and replace.
			-- (from TREE)
		require -- from TREE
			is_writable: writable
		ensure -- from TREE
			item_inserted: item = v

	replace_child (n: like parent)
			-- Put n at current child position.
			-- (from 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

	remove_child
			-- Remove child at cursor position.
			-- Move cursor to next sibling, or after if none.
		require
			child_not_off: not child_off
		ensure
			new_arity: arity = old arity - 1;
			new_child_index: child_index = old child_index

	remove_left_child
			-- Remove item to the left of cursor position.
			-- Do not move cursor.
		require
			is_not_first: not child_isfirst
		ensure
			new_arity: arity = old arity - 1;
			new_child_index: child_index = old child_index - 1

	remove_right_child
			-- Remove item to the right of cursor position.
			-- Do not move cursor.
		require
			is_not_last: not child_islast
		ensure
			new_arity: arity = old arity - 1;
			new_child_index: child_index = old child_index

	wipe_out
			-- Remove all child
	
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

	fill_from_binary (b: BINARY_TREE [G])
			-- Fill from a binary tree representation.
			-- Left child becomes first child.
			-- Right child becomes right sibling.
			-- Any right child of b is ignored.

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

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

		-- from GENERAL
	reflexive_equality: standard_is_equal (Current);
	reflexive_conformance: conforms_to (Current);
	extendible_definition: extendible;
	child_after_definition: child_after = (child_index = arity + 1);
		-- 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 = arity);
	child_after_definition: child_after = (child_index >= arity + 1);
	child_consistency: child_readable implies child.parent = Current;

end -- class DYNAMIC_TREE