Automatic generation produced by ISE Eiffel

Classes
Clusters
Cluster hierarchy
Chart
Relations
Text
Flat
Contracts
Flat contracts
Go to: 
indexing
	description: "Sorted sets implemented as binary search trees"
	status: "See notice at end of class"
	names: binary_search_tree_set, set, binary_search_tree
	representation: recursive, array
	access: membership, min, max
	contents: generic
	date: "$Date: 2001-11-16 20:32:23 +0000 (Fri, 16 Nov 2001) $"
	revision: "$Revision: 51435 $"

class 
	BINARY_SEARCH_TREE_SET [G -> COMPARABLE]

create 
	make

feature -- Initialization

	make is
			-- Create set.
		do
			before := True
		end
	
feature {NONE} -- Access

	index_of (v: like item; i: INTEGER): INTEGER is
			-- Index of i-th occurrence of v.
			-- 0 if none.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from LINEAR)
		require -- from LINEAR
			positive_occurrences: i > 0
		local
			occur, pos: INTEGER
		do
			if object_comparison and v /= void then
				from
					start
					pos := 1
				until
					off or (occur = i)
				loop
					if item /= void and then v.is_equal (item) then
						occur := occur + 1
					end
					forth
					pos := pos + 1
				end
			else
				from
					start
					pos := 1
				until
					off or (occur = i)
				loop
					if item = v then
						occur := occur + 1
					end
					forth
					pos := pos + 1
				end
			end
			if occur = i then
				Result := pos - 1
			end
		ensure -- from LINEAR
			non_negative_result: Result >= 0
		end

	occurrences (v: G): INTEGER is
			-- Number of times v appears.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from LINEAR)
		do
			from
				start
				search (v)
			until
				exhausted
			loop
				Result := Result + 1
				forth
				search (v)
			end
		end

	sequential_search (v: like item) is
			-- Move to first position (at or after current
			-- position) where item and v are equal.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- If no such position ensure that exhausted will be true.
			-- (from LINEAR)
		do
			if object_comparison and v /= void then
				from
				until
					exhausted or else (item /= void and then v.is_equal (item))
				loop
					forth
				end
			else
				from
				until
					exhausted or else v = item
				loop
					forth
				end
			end
		ensure -- from LINEAR
			object_found: (not exhausted and object_comparison) implies equal (v, item)
			item_found: (not exhausted and not object_comparison) implies v = item
		end
	
feature -- Measurement

	count: INTEGER is
			-- Number of items in tree
		do
			if tree /= void then
				Result := tree.count
			end
		end

	item: G is
			-- Current item
		require -- from TRAVERSABLE
			not_off: not off
		require -- from TRAVERSABLE_SUBSET
			not_off: not off
		do
			Result := active_node.item
		end

	max: like item is
			-- Maximum item in tree
		require -- from COMPARABLE_SET
			not_empty: not is_empty
		do
			Result := tree.max
		end

	min: like item is
			-- Minimum item in tree
		require -- from COMPARABLE_SET
			not_empty: not is_empty
		do
			Result := tree.min
		end
	
feature {NONE} -- Measurement

	cs_max: like item is
			-- Maximum item
			-- (from COMPARABLE_STRUCT)
		require -- from COMPARABLE_STRUCT
			min_max_available
		do
			from
				start
				Result := item
				forth
			until
				off
			loop
				if item > Result then
					Result := item
				end
				forth
			end
		end

	cs_min: like item is
			-- Minimum item
			-- (from COMPARABLE_STRUCT)
		require -- from COMPARABLE_STRUCT
			min_max_available
		do
			from
				start
				Result := item
				forth
			until
				off
			loop
				if item < Result then
					Result := item
				end
				forth
			end
		end

	min_max_available: BOOLEAN is
			-- Can min and max be computed?
			-- (from COMPARABLE_STRUCT)
		do
			Result := not is_empty
		ensure -- from COMPARABLE_STRUCT
			Result implies not is_empty
		end
	
feature -- Comparison

	disjoint (other: TRAVERSABLE_SUBSET [G]): BOOLEAN is
			-- Do current set and other have no
			-- items in common?
			-- (from TRAVERSABLE_SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison
		local
			s: SUBSET_STRATEGY [G]
		do
			if not is_empty and not other.is_empty then
				s := subset_strategy (other)
				Result := s.disjoint (Current, other)
			else
				Result := True
			end
		end

	is_subset (other: TRAVERSABLE_SUBSET [G]): BOOLEAN is
			-- Is current set a subset of other?
			-- (from TRAVERSABLE_SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison
		do
			if not other.is_empty and then count <= other.count then
				from
					start
				until
					off or else not other.has (item)
				loop
					forth
				end
				if off then
					Result := True
				end
			elseif is_empty then
				Result := True
			end
		end

	is_superset (other: SUBSET [G]): BOOLEAN is
			-- Is current set a superset of other?
			-- (from SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison
		do
			Result := other.is_subset (Current)
		end
	
feature -- Status report

	after: BOOLEAN
			-- Is there no valid cursor position to the right of cursor?

	before: BOOLEAN
			-- Is there no valid cursor position to the left of cursor?

	empty: BOOLEAN is
		obsolete "ELKS 2000: Use `is_empty' instead"
			-- Is there no element?
			-- (from CONTAINER)
		do
			Result := is_empty
		end

	Extendible: BOOLEAN is True
			-- Can new items be added? (Answer: yes.)

	has (v: like item): BOOLEAN is
			-- Is there a node with item v in tree?
			-- (Reference or object equality,
			-- based on object_comparison.)
		do
			if tree /= void then
				Result := tree.has (v)
			end
		ensure -- from CONTAINER
			not_found_in_empty: Result implies not is_empty
		end

	is_empty: BOOLEAN is
			-- Is set empty?
		do
			Result := tree = void
		end

	is_inserted (v: G): BOOLEAN is
			-- Has v been inserted by the most recent insertion?
			-- (By default, the value returned is equivalent to calling
			-- `has (v)'. However, descendants might be able to provide more
			-- efficient implementations.)
			-- (from COLLECTION)
		do
			Result := has (v)
		end

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

	off: BOOLEAN is
			-- Is there no current item?
			-- off only if tree is_empty or if
			-- it is before or after.
		do
			Result := is_empty or Precursor {COMPARABLE_SET}
		end

	Prunable: BOOLEAN is True
			-- Can items be removed? (Answer: yes.)
	
feature {NONE} -- Status report

	exhausted: BOOLEAN is
			-- Has structure been completely explored?
			-- (from LINEAR)
		do
			Result := off
		ensure -- from LINEAR
			exhausted_when_off: off implies Result
		end
	
feature -- Status setting

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

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

	back is
			-- Move cursor to previous node.
		require -- from BILINEAR
			not_before: not before
		local
			prev_node: like tree
		do
			if after then
				after := False
				if is_empty then
					before := True
				end
			else
				if active_node.has_left then
					active_node := active_node.left_child.max_node
				else
					prev_node := active_node
					active_node := active_node.parent
					from
					until
						active_node = void or else prev_node = active_node.right_child
					loop
						prev_node := active_node
						active_node := active_node.parent
					end
					if active_node = void then
						active_node := tree
						before := True
					end
				end
			end
		end

	finish is
			-- Move cursor to last node.
		do
			after := False
			if tree = void then
				before := True
			else
				before := False
				active_node := tree.max_node
			end
		end

	forth is
			-- Move cursor to next node.
		require -- from LINEAR
			not_after: not after
		require -- from TRAVERSABLE_SUBSET
			not_after: not after
		local
			prev_node: like tree
		do
			if before then
				before := False
				if is_empty then
					after := True
				end
			else
				if active_node.has_right then
					active_node := active_node.right_child.min_node
				else
					prev_node := active_node
					active_node := active_node.parent
					from
					until
						active_node = void or else prev_node = active_node.left_child
					loop
						prev_node := active_node
						active_node := active_node.parent
					end
					if active_node = void then
						active_node := tree
						after := True
					end
				end
			end
		end

	start is
			-- Move cursor to first node.
		do
			before := False
			if tree = void then
				after := True
			else
				after := False
				active_node := tree.min_node
			end
		end
	
feature {NONE} -- Cursor movement

	search (v: like item) is
			-- Move to first position (at or after current
			-- position) where item and v are equal.
			-- If structure does not include v ensure that
			-- exhausted will be true.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from BILINEAR)
		do
			if before and not is_empty then
				forth
			end
			sequential_search (v)
		ensure -- from LINEAR
			object_found: (not exhausted and object_comparison) implies equal (v, item)
			item_found: (not exhausted and not object_comparison) implies v = item
		end
	
feature -- Element change

	extend (v: like item) is
			-- Put v at proper position in set
			-- (unless one already exists).
			-- Was declared in BINARY_SEARCH_TREE_SET as synonym of put.
		require -- from COLLECTION
			extendible: extendible
		require else
			item_exists: v /= void
		do
			if tree = void then
				tree := new_tree (v)
			else
				if not has (v) then
					tree.extend (v)
				end
			end
		ensure -- from COLLECTION
			item_inserted: is_inserted (v)
		ensure then -- from SET
			in_set_already: old has (v) implies (count = old count)
			added_to_set: not old has (v) implies (count = old count + 1)
		end

	fill (other: CONTAINER [G]) is
			-- Fill with as many items of other as possible.
			-- The representations of other and current structure
			-- need not be the same.
			-- (from COLLECTION)
		require -- from COLLECTION
			other_not_void: other /= void
			extendible
		local
			lin_rep: LINEAR [G]
		do
			lin_rep := other.linear_representation
			from
				lin_rep.start
			until
				not extendible or else lin_rep.off
			loop
				extend (lin_rep.item)
				lin_rep.forth
			end
		end

	merge (other: CONTAINER [G]) is
			-- Add all items of other.
			-- (from TRAVERSABLE_SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison
		local
			lin_rep: LINEAR [G]
		do
			lin_rep ?= other
			if lin_rep = void then
				lin_rep := other.linear_representation
			end
			from
				lin_rep.start
			until
				lin_rep.off
			loop
				extend (lin_rep.item)
				lin_rep.forth
			end
		end

	put (v: like item) is
			-- Put v at proper position in set
			-- (unless one already exists).
			-- Was declared in BINARY_SEARCH_TREE_SET as synonym of extend.
		require -- from COLLECTION
			extendible: extendible
		require else
			item_exists: v /= void
		do
			if tree = void then
				tree := new_tree (v)
			else
				if not has (v) then
					tree.extend (v)
				end
			end
		ensure -- from COLLECTION
			item_inserted: is_inserted (v)
		ensure then -- from SET
			in_set_already: old has (v) implies (count = old count)
			added_to_set: not old has (v) implies (count = old count + 1)
		end
	
feature -- Removal

	changeable_comparison_criterion: BOOLEAN is
			-- May object_comparison be changed?
			-- (Answer: only if set empty; otherwise insertions might
			-- introduce duplicates, destroying the set property.)
			-- (from SET)
		do
			Result := is_empty
		ensure then -- from SET
			only_on_empty: Result = is_empty
		end

	prune (v: like item) is
			-- Remove v.
		require -- from COLLECTION
			prunable: prunable
		do
			if tree /= void then
				tree := tree.pruned (v, tree.parent)
			end
		ensure then -- from SET
			removed_count_change: old has (v) implies (count = old count - 1)
			not_removed_no_count_change: not old has (v) implies (count = old count)
			item_deleted: not has (v)
		end

	prune_all (v: G) is
			-- Remove all occurrences of v.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from COLLECTION)
		require -- from COLLECTION
			prunable
		do
			from
			until
				not has (v)
			loop
				prune (v)
			end
		ensure -- from COLLECTION
			no_more_occurrences: not has (v)
		end

	remove is
			-- Remove current item.
		require -- from TRAVERSABLE_SUBSET
			not_off: not off
		do
			prune (item)
		end

	wipe_out is
			-- Remove all items.
		require -- from COLLECTION
			prunable
		do
			tree := void
		ensure -- from COLLECTION
			wiped_out: is_empty
		end
	
feature -- Conversion

	linear_representation: LINEAR [G] is
			-- Representation as a linear structure
			-- (from LINEAR)
		do
			Result := Current
		end
	
feature -- Duplication

	duplicate (n: INTEGER): BINARY_SEARCH_TREE_SET [G] is
			-- New structure containing min (n, count)
			-- items from current structure
		require -- from SUBSET
			non_negative: n >= 0
		do
			create Result.make
			Result.set_tree (tree.duplicate (n))
		ensure -- from SUBSET
			correct_count_1: n <= count implies Result.count = n
			correct_count_2: n >= count implies Result.count = count
		end
	
feature -- Basic operations

	intersect (other: TRAVERSABLE_SUBSET [G]) is
			-- Remove all items not in other.
			-- No effect if other is_empty.
			-- (from TRAVERSABLE_SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison
		do
			if not other.is_empty then
				from
					start
					other.start
				until
					off
				loop
					if other.has (item) then
						forth
					else
						remove
					end
				end
			else
				wipe_out
			end
		ensure -- from SUBSET
			is_subset_other: is_subset (other)
		end

	subtract (other: TRAVERSABLE_SUBSET [G]) is
			-- Remove all items also in other.
			-- (from TRAVERSABLE_SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison
		do
			if not (other.is_empty or is_empty) then
				from
					start
					other.start
				until
					off
				loop
					if other.has (item) then
						remove
					else
						forth
					end
				end
			end
		ensure -- from SUBSET
			is_disjoint: disjoint (other)
		end

	symdif (other: TRAVERSABLE_SUBSET [G]) is
			-- Remove all items also in other, and add all
			-- items of other not already present.
			-- (from TRAVERSABLE_SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison
		local
			s: SUBSET_STRATEGY [G]
		do
			if not other.is_empty then
				if is_empty then
					copy (other)
				else
					s := subset_strategy (other)
					s.symdif (Current, other)
				end
			end
		end
	
feature {NONE} -- Inapplicable

	index: INTEGER is
			-- (from COMPARABLE_STRUCT)
		do
		end
	
feature {BINARY_SEARCH_TREE_SET} -- Implementation

	active_node: like tree

	set_tree (t: like tree) is
			-- Set tree and active_node to t
		do
			tree := t
			active_node := t
		end

	tree: BINARY_SEARCH_TREE [G]
	
feature {NONE} -- Implementation

	new_tree (v: like item): like tree is
			-- New allocated node with item set to v
		do
			create Result.make (v)
			if object_comparison then
				Result.compare_objects
			end
		end

	subset_strategy (other: TRAVERSABLE_SUBSET [G]): SUBSET_STRATEGY [G] is
			-- Subset strategy suitable for the type of the contained elements.
			-- (from TRAVERSABLE_SUBSET)
		require -- from TRAVERSABLE_SUBSET
			not_empty: not is_empty
		do
			start
			check
				not_off: not off
			end
			Result := subset_strategy_selection (item, other)
		end

	subset_strategy_selection (v: G; other: TRAVERSABLE_SUBSET [G]): SUBSET_STRATEGY [G] is
			-- Strategy to calculate several subset features selected depending
			-- on the dynamic type of v and other
		require -- from TRAVERSABLE_SUBSET
			item_exists: v /= void
			other_exists: other /= void
		local
			h: HASHABLE
		do
			h ?= v
			if h /= void and object_comparison then
				create {SUBSET_STRATEGY_HASHABLE [G]} Result
			elseif object_comparison and same_type (other) then
				create {SUBSET_STRATEGY_TREE [G]} Result
			else
				create {SUBSET_STRATEGY_GENERIC [G]} Result
			end
		ensure -- from TRAVERSABLE_SUBSET
			strategy_set: Result /= void
		end
	
feature {NONE} -- Iteration

	do_all (action: PROCEDURE [ANY, TUPLE [G]]) is
			-- Apply action to every item.
			-- Semantics not guaranteed if action changes the structure;
			-- in such a case, apply iterator to clone of structure instead.
			-- (from LINEAR)
		require -- from TRAVERSABLE
			action_exists: action /= void
		local
			t: TUPLE [G]
		do
			create t.make
			from
				start
			until
				after
			loop
				t.put (item, 1)
				action.call (t)
				forth
			end
		end

	do_if (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) is
			-- Apply action to every item that satisfies test.
			-- Semantics not guaranteed if action or test changes the structure;
			-- in such a case, apply iterator to clone of structure instead.
			-- (from LINEAR)
		require -- from TRAVERSABLE
			action_exists: action /= void
			test_exits: test /= void
		local
			t: TUPLE [G]
		do
			create t.make
			from
				start
			until
				after
			loop
				t.put (item, 1)
				if test.item (t) then
					action.call (t)
				end
				forth
			end
		end

	for_all (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]): BOOLEAN is
			-- Is test true for all items?
			-- (from LINEAR)
		require -- from TRAVERSABLE
			test_exits: test /= void
		local
			cs: CURSOR_STRUCTURE [G]
			c: CURSOR
			t: TUPLE [G]
		do
			create t.make
			cs ?= Current
			if cs /= void then
				c := cs.cursor
			end
			from
				start
				Result := True
			until
				after or not Result
			loop
				t.put (item, 1)
				Result := test.item (t)
				forth
			end
			if cs /= void then
				cs.go_to (c)
			end
		end

	there_exists (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]): BOOLEAN is
			-- Is test true for at least one item?
			-- (from LINEAR)
		require -- from TRAVERSABLE
			test_exits: test /= void
		local
			cs: CURSOR_STRUCTURE [G]
			c: CURSOR
			t: TUPLE [G]
		do
			create t.make
			cs ?= Current
			if cs /= void then
				c := cs.cursor
			end
			from
				start
			until
				after or Result
			loop
				t.put (item, 1)
				Result := test.item (t)
				forth
			end
			if cs /= void then
				cs.go_to (c)
			end
		end
	
invariant

	comparison_mode_equal: tree /= void implies object_comparison = tree.object_comparison
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)
		-- from COMPARABLE_STRUCT
	empty_constraint: min_max_available implies not is_empty
		-- from BILINEAR
	not_both: not (after and before)
	before_constraint: before implies off
		-- from LINEAR
	after_constraint: after implies off
		-- from TRAVERSABLE
	empty_constraint: is_empty implies off
		-- from TRAVERSABLE_SUBSET
	empty_definition: is_empty = (count = 0)
	count_range: count >= 0

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_SET


Classes
Clusters
Cluster hierarchy
Chart
Relations
Text
Flat
Contracts
Flat contracts
Go to: 

-- Generated by ISE Eiffel --
For more details: www.eiffel.com