indexing
	description: "[
		Subsets that are traversable linearly without commitment to a concrete
		implementation.
	]"
	status: "See notice at end of class"
	names: linear_subset, subset, set
	access: membership
	contents: generic
	date: "$Date$"
	revision: "$Revision$"

deferred class interface
	LINEAR_SUBSET [G]

feature -- Access

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

	index: INTEGER
			-- Current index

	item: G
			-- Current item
			-- (from TRAVERSABLE_SUBSET)
		require -- from TRAVERSABLE_SUBSET
			not_off: not off

feature -- Measurement

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

feature -- Comparison

	disjoint (other: TRAVERSABLE_SUBSET [G]): BOOLEAN
			-- 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

	is_subset (other: TRAVERSABLE_SUBSET [G]): BOOLEAN
			-- Is current set a subset of other?
			-- (from TRAVERSABLE_SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison

	is_superset (other: SUBSET [G]): BOOLEAN
			-- Is current set a superset of other?
			-- (from SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison

feature -- Status report

	after: BOOLEAN
			-- Is cursor behind last item?
			-- (from TRAVERSABLE_SUBSET)

	before: BOOLEAN
			-- Is cursor at left from first item?

	extendible: BOOLEAN
			-- May new items be added?
			-- (from COLLECTION)

	is_empty: BOOLEAN
			-- Is container empty?
			-- (from TRAVERSABLE_SUBSET)

	is_inserted (v: G): BOOLEAN
			-- 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)

	islast: BOOLEAN
			-- Is cursor at last item?

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

	off: BOOLEAN
			-- Is cursor off the active items?
			-- (from TRAVERSABLE_SUBSET)

	prunable: BOOLEAN
			-- May items be removed?
			-- (from COLLECTION)

	valid_index (n: INTEGER): BOOLEAN
			-- Is n a valid index?
		ensure
			index_valid: 0 <= n and n <= count + 1

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

	forth
			-- Move cursor to next element.
			-- (from TRAVERSABLE_SUBSET)
		require -- from TRAVERSABLE_SUBSET
			not_after: not after

	go_i_th (i: INTEGER)
			-- Move cursor to i-th item.
		require
			valid_index: valid_index (i)
		ensure
			cursor_moved: index = i

	start
			-- Move cursor to first item.
			-- (from TRAVERSABLE_SUBSET)

feature -- Element change

	extend (v: G)
			-- Ensure that set includes v.
			-- Was declared in SET as synonym of put.
			-- (from SET)
		require -- from COLLECTION
			extendible: extendible
		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)

	fill (other: CONTAINER [G])
			-- 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

	merge (other: CONTAINER [G])
			-- Add all items of other.
			-- (from TRAVERSABLE_SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison

	move_item (v: G)
			-- Move v to the left of cursor.
		require
			item_exists: v /= void
			item_in_set: has (v)

	put (v: G)
			-- Ensure that set includes v.
			-- Was declared in SET as synonym of extend.
			-- (from SET)
		require -- from COLLECTION
			extendible: extendible
		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)

	put_left (v: G)
			-- Insert v before the cursor.
		require
			item_exists: v /= void
			not_before: not before
		ensure
			cursor_position_unchanged: index = old index + 1

feature -- Removal

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

	prune (v: G)
			-- Remove v if present.
			-- (from SET)
		require -- from COLLECTION
			prunable: prunable
		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)

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

	remove
			-- Remove current item.
			-- (from TRAVERSABLE_SUBSET)
		require -- from TRAVERSABLE_SUBSET
			not_off: not off

	wipe_out
			-- Remove all items.
			-- (from COLLECTION)
		require -- from COLLECTION
			prunable
		ensure -- from COLLECTION
			wiped_out: is_empty

feature -- Conversion

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

feature -- Duplication

	duplicate (n: INTEGER): like Current
			-- New structure containing min (n, count)
			-- items from current structure
			-- (from SUBSET)
		require -- from SUBSET
			non_negative: n >= 0
		ensure -- from SUBSET
			correct_count_1: n <= count implies Result.count = n
			correct_count_2: n >= count implies Result.count = count

feature -- Basic operations

	intersect (other: TRAVERSABLE_SUBSET [G])
			-- 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
		ensure -- from SUBSET
			is_subset_other: is_subset (other)

	subtract (other: TRAVERSABLE_SUBSET [G])
			-- Remove all items also in other.
			-- (from TRAVERSABLE_SUBSET)
		require -- from SUBSET
			set_exists: other /= void
			same_rule: object_comparison = other.object_comparison
		ensure -- from SUBSET
			is_disjoint: disjoint (other)

	symdif (other: TRAVERSABLE_SUBSET [G])
			-- 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

invariant

	before_definition: before = (index = 0)
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)
		-- 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 LINEAR_SUBSET