indexing
	description: "Dynamically modifiable circular chains"
	legal: "See notice at end of class."
	status: "See notice at end of class."
	names: dynamic_circular, ring, sequence
	access: index, cursor, membership
	contents: generic
	date: "$Date: 2007-01-14 01:47:13 -0800 (Sun, 14 Jan 2007) $"
	revision: "$Revision: 55 $"

deferred class interface
	DYNAMIC_CIRCULAR [G]


feature -- Access

	cursor: CURSOR
			-- Current cursor position
			-- (from CURSOR_STRUCTURE)
		ensure -- from CURSOR_STRUCTURE
			cursor_not_void: Result /= Void

	first: G
			-- Item at position currently defined as first
			-- (from CIRCULAR)
		require -- from CHAIN
			not_empty: not is_empty

	generating_type: STRING_8
			-- Name of current object's generating type
			-- (type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generating_type_not_void: Result /= Void
			generating_type_not_empty: not Result.is_empty

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generator_not_void: Result /= Void
			generator_not_empty: not Result.is_empty

	has (v: like item): BOOLEAN
			-- Does chain include `v'?
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from CHAIN)
		require -- from  CONTAINER
			True
		ensure -- from CONTAINER
			not_found_in_empty: Result implies not is_empty

	i_th alias "[]" (i: INTEGER_32): like item assign put_i_th
			-- Item at `i'-th position
			-- Was declared in CHAIN as synonym of infix "@".
			-- (from CHAIN)
		require -- from TABLE
			valid_key: valid_index (i)

	index: INTEGER_32
			-- Current cursor index, with respect to position
			-- currently defined as first
			-- (from CIRCULAR)
		require -- from  LINEAR
			True

	index_of (v: like item; i: INTEGER_32): INTEGER_32
			-- Index of `i'-th occurrence of item identical to `v'.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- 0 if none.
			-- (from CHAIN)
		require -- from LINEAR
			positive_occurrences: i > 0
		ensure -- from LINEAR
			non_negative_result: Result >= 0

	item: G
			-- Current item
			-- (from ACTIVE)
		require -- from TRAVERSABLE
			not_off: not off
		require -- from ACTIVE
			readable: readable

	item_for_iteration: G
			-- Item at current position
			-- (from LINEAR)
		require -- from LINEAR
			not_off: not off

	last: like first
			-- Item at position currently defined as last
			-- (from CIRCULAR)
		require -- from CHAIN
			not_empty: not is_empty

	sequential_occurrences (v: like item): INTEGER_32
			-- Number of times `v' appears.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from LINEAR)
		require -- from  BAG
			True
		ensure -- from BAG
			non_negative_occurrences: Result >= 0

	infix "@" (i: INTEGER_32): like item assign put_i_th
			-- Item at `i'-th position
			-- Was declared in CHAIN as synonym of i_th.
			-- (from CHAIN)
		require -- from TABLE
			valid_key: valid_index (i)
	
feature -- Measurement

	count: INTEGER_32
			-- Number of items
			-- (from FINITE)

	index_set: INTEGER_INTERVAL
			-- Range of acceptable indexes
			-- (from CHAIN)
		require -- from  INDEXABLE
			True
		ensure -- from INDEXABLE
			not_void: Result /= Void
		ensure then -- from CHAIN
			count_definition: Result.count = count

	occurrences (v: like item): INTEGER_32
			-- Number of times `v' appears.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- (from CHAIN)
		require -- from  BAG
			True
		require -- from  LINEAR
			True
		ensure -- from BAG
			non_negative_occurrences: Result >= 0
	
feature -- Comparison

	frozen deep_equal (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			shallow_implies_deep: standard_equal (some, other) implies Result
			both_or_none_void: (some = Void) implies (Result = (other = Void))
			same_type: (Result and (some /= Void)) implies (other /= Void and then some.same_type (other))
			symmetric: Result implies deep_equal (other, some)

	frozen equal (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))

	frozen is_deep_equal (other: DYNAMIC_CIRCULAR [G]): BOOLEAN
			-- Are `Current' and `other' attached to isomorphic object structures?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			shallow_implies_deep: standard_is_equal (other) implies Result
			same_type: Result implies same_type (other)
			symmetric: Result implies other.is_deep_equal (Current)

	is_equal (other: DYNAMIC_CIRCULAR [G]): BOOLEAN
			-- Is `other' attached to an object considered
			-- equal to current object?
			-- (from ANY)
		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

	frozen standard_equal (some: ?ANY; other: like arg #1): BOOLEAN
			-- Are `some' and `other' either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		ensure -- from ANY
			definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))

	frozen standard_is_equal (other: DYNAMIC_CIRCULAR [G]): BOOLEAN
			-- Is `other' attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
feature -- Status report

	after: BOOLEAN
			-- Is there no valid cursor position to the right of cursor?
			-- (from CIRCULAR)
		require -- from  LINEAR
			True
		ensure then -- from CIRCULAR
			empty_and_std_after: Result = (is_empty and standard_after)

	before: BOOLEAN
			-- Is there no valid cursor position to the right of cursor?
			-- (from CIRCULAR)
		require -- from  BILINEAR
			True
		ensure then -- from CIRCULAR
			empty_and_std_before: Result = (is_empty and standard_before)

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

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of `other' (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void

	exhausted: BOOLEAN
			-- Has structure been completely explored?
			-- (from CIRCULAR)
		require -- from  LINEAR
			True
		ensure -- from LINEAR
			exhausted_when_off: off implies Result

	extendible: BOOLEAN is True
			-- May new items be added? (Answer: yes.)
			-- (from DYNAMIC_CHAIN)

	full: BOOLEAN
			-- Is structure filled to capacity?
			-- (from BOX)

	is_empty: BOOLEAN
			-- Is structure empty?
			-- (from FINITE)
		require -- from  CONTAINER
			True

	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)

	isfirst: BOOLEAN
			-- Is cursor at first position?
			-- (from CHAIN)
		ensure -- from CHAIN
			valid_position: Result implies not is_empty

	islast: BOOLEAN
			-- Is cursor at last position?
			-- (from CHAIN)
		ensure -- from CHAIN
			valid_position: Result implies not is_empty

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

	off: BOOLEAN
			-- Is there no current item?
			-- (from CIRCULAR)
		require -- from  TRAVERSABLE
			True
		ensure then -- from CIRCULAR
			only_when_empty: Result = is_empty

	prunable: BOOLEAN
			-- May items be removed? (Answer: yes.)
			-- (from DYNAMIC_CHAIN)
		require -- from  COLLECTION
			True

	readable: BOOLEAN
			-- Is there a current item that may be read?
			-- (from SEQUENCE)
		require -- from  ACTIVE
			True

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of `other'?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))

	valid_cursor (p: CURSOR): BOOLEAN
			-- Can the cursor be moved to position `p'?
			-- (from CURSOR_STRUCTURE)

	valid_cursor_index (i: INTEGER_32): BOOLEAN
			-- Is `i' a possible cursor position?
			-- (from CIRCULAR)
		require -- from  CHAIN
			True
		ensure -- from CHAIN
			valid_cursor_index_definition: Result = ((i >= 0) and (i <= count + 1))
		ensure then -- from CIRCULAR
			valid_cursor_index_definition: Result = ((i >= 0) and (i <= count))

	valid_index (i: INTEGER_32): BOOLEAN
			-- Is `i' within allowable bounds?
			-- (from CHAIN)
		require -- from  TABLE
			True
		ensure then -- from INDEXABLE
			only_if_in_index_set: Result implies ((i >= index_set.lower) and (i <= index_set.upper))
		ensure then -- from CHAIN
			valid_index_definition: Result = ((i >= 1) and (i <= count))

	writable: BOOLEAN
			-- Is there a current item that may be modified?
			-- (from SEQUENCE)
		require -- from  ACTIVE
			True
	
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: 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: changeable_comparison_criterion
		ensure -- from CONTAINER
			reference_comparison: not object_comparison
	
feature -- Cursor movement

	back
			-- Move cursor to previous item, cyclically.
			-- (from CIRCULAR)
		require -- from BILINEAR
			not_before: not before

	finish
			-- Move cursor to last position.
			-- (No effect if empty)
			-- (from CHAIN)
		require -- from  LINEAR
			True
		ensure then -- from CHAIN
			at_last: not is_empty implies islast

	forth
			-- Move cursor to next item, cyclically.
			-- (from CIRCULAR)
		require -- from LINEAR
			not_after: not after
		ensure then -- from CIRCULAR
			moved_forth_at_end: (old index = count) implies (index = 1)

	go_i_th (i: INTEGER_32)
			-- Move cursor to `i'-th position from current start, cyclically.
			-- (from CIRCULAR)
		require -- from CHAIN
			valid_cursor_index: valid_cursor_index (i)
		require else -- from CIRCULAR
			index_big_enough: i >= 1
			not_empty: not is_empty
		ensure -- from CHAIN
			position_expected: index = i

	go_to (p: CURSOR)
			-- Move cursor to position `p'.
			-- (from CURSOR_STRUCTURE)
		require -- from CURSOR_STRUCTURE
			cursor_position_valid: valid_cursor (p)

	move (i: INTEGER_32)
			-- Move cursor to `i'-th item from current position,
			-- cyclically.
			-- (from CIRCULAR)
		require -- from  CHAIN
			True
		ensure -- from CHAIN
			too_far_right: (old index + i > count) implies exhausted
			too_far_left: (old index + i < 1) implies exhausted
			expected_index: (not exhausted) implies (index = old index + i)

	search (v: like item)
			-- 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)
		require -- from  LINEAR
			True
		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

	set_start
			-- Define current position as the first.
			-- (from CIRCULAR)
		require -- from CIRCULAR
			not_empty: not is_empty

	start
			-- Move cursor to first position.
			-- (No effect if empty)
			-- (from CHAIN)
		require -- from  TRAVERSABLE
			True
		ensure then -- from CHAIN
			at_first: not is_empty implies isfirst
	
feature -- Element change

	append (s: SEQUENCE [G])
			-- Append a copy of `s'.
			-- (from CHAIN)
		require -- from SEQUENCE
			argument_not_void: s /= Void
		ensure -- from SEQUENCE
			new_count: count >= old count

	extend (v: G)
			-- Add a new occurrence of `v'.
			-- (from BAG)
		require -- from COLLECTION
			extendible: extendible
		ensure -- from COLLECTION
			item_inserted: is_inserted (v)
		ensure then -- from BAG
			one_more_occurrence: occurrences (v) = old (occurrences (v)) + 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 CHAIN)
		require -- from COLLECTION
			other_not_void: other /= Void
			extendible: extendible

	force (v: like item)
			-- Add `v' to end.
			-- (from SEQUENCE)
		require -- from SEQUENCE
			extendible: extendible
		ensure then -- from SEQUENCE
			new_count: count = old count + 1
			item_inserted: has (v)

	merge_left (other: DYNAMIC_CIRCULAR [G])
			-- Merge `other' into current structure before cursor
			-- position. Do not move cursor. Empty `other'.
			-- (from DYNAMIC_CHAIN)
		require -- from DYNAMIC_CHAIN
			extendible: extendible
			not_before: not before
			other_exists: other /= Void
			not_current: other /= Current
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count + old other.count
			new_index: index = old index + old other.count
			other_is_empty: other.is_empty

	merge_right (other: DYNAMIC_CIRCULAR [G])
			-- Merge `other' into current structure after cursor
			-- position. Do not move cursor. Empty `other'.
			-- (from DYNAMIC_CHAIN)
		require -- from DYNAMIC_CHAIN
			extendible: extendible
			not_after: not after
			other_exists: other /= Void
			not_current: other /= Current
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count + old other.count
			same_index: index = old index
			other_is_empty: other.is_empty

	put (v: like item)
			-- Replace current item by `v'.
			-- (Synonym for replace)
			-- (from CHAIN)
		require -- from COLLECTION
			extendible: extendible
		ensure -- from COLLECTION
			item_inserted: is_inserted (v)
		ensure then -- from CHAIN
			same_count: count = old count

	put_front (v: like item)
			-- Add `v' at beginning.
			-- Do not move cursor.
			-- (from DYNAMIC_CHAIN)
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count + 1
			item_inserted: first = v

	put_i_th (v: like item; i: INTEGER_32)
			-- Put `v' at `i'-th position.
			-- (from CHAIN)
		require -- from TABLE
			valid_key: valid_index (i)
		ensure then -- from INDEXABLE
			insertion_done: i_th (i) = v

	put_left (v: like item)
			-- Add `v' to the left of cursor position.
			-- Do not move cursor.
			-- (from DYNAMIC_CHAIN)
		require -- from DYNAMIC_CHAIN
			extendible: extendible
			not_before: not before
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count + 1
			new_index: index = old index + 1

	put_right (v: like item)
			-- Add `v' to the right of cursor position.
			-- Do not move cursor.
			-- (from DYNAMIC_CHAIN)
		require -- from DYNAMIC_CHAIN
			extendible: extendible
			not_after: not after
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count + 1
			same_index: index = old index

	replace (v: G)
			-- Replace current item by `v'.
			-- (from ACTIVE)
		require -- from ACTIVE
			writable: writable
		ensure -- from ACTIVE
			item_replaced: item = v
	
feature -- Removal

	prune (v: like item)
			-- Remove first occurrence of `v', if any,
			-- after cursor position.
			-- If found, move cursor to right neighbor;
			-- if not, make structure exhausted.
			-- (from DYNAMIC_CHAIN)
		require -- from COLLECTION
			prunable: prunable

	prune_all (v: like item)
			-- Remove all occurrences of `v'.
			-- (Reference or object equality,
			-- based on object_comparison.)
			-- Leave structure exhausted.
			-- (from DYNAMIC_CHAIN)
		require -- from COLLECTION
			prunable: prunable
		ensure -- from COLLECTION
			no_more_occurrences: not has (v)
		ensure then -- from DYNAMIC_CHAIN
			is_exhausted: exhausted

	remove
			-- Remove item at cursor position.
			-- Move cursor to right neighbor (cyclically).
			-- If removed item was at current starting position,
			-- move starting position to right neighbor.
			-- (from CIRCULAR)
		require -- from ACTIVE
			prunable: prunable
			writable: writable

	remove_left
			-- Remove item to the left of cursor position.
			-- Do not move cursor.
			-- (from DYNAMIC_CHAIN)
		require -- from DYNAMIC_CHAIN
			left_exists: index > 1
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count - 1
			new_index: index = old index - 1

	remove_right
			-- Remove item to the right of cursor position.
			-- Do not move cursor.
			-- (from DYNAMIC_CHAIN)
		require -- from DYNAMIC_CHAIN
			right_exists: index < count
		ensure -- from DYNAMIC_CHAIN
			new_count: count = old count - 1
			same_index: index = old index

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

	swap (i: INTEGER_32)
			-- Exchange item at `i'-th position with item
			-- at cursor position.
			-- (from CHAIN)
		require -- from CHAIN
			not_off: not off
			valid_index: valid_index (i)
		ensure -- from CHAIN
			swapped_to_item: item = old i_th (i)
			swapped_from_item: i_th (i) = old item
	
feature -- Conversion

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

	copy (other: DYNAMIC_CIRCULAR [G])
			-- Update current object using fields of object attached
			-- to `other', so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: is_equal (other)

	frozen deep_copy (other: DYNAMIC_CIRCULAR [G])
			-- Effect equivalent to that of:
			--		copy (`other' . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

	frozen deep_twin: DYNAMIC_CIRCULAR [G]
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		ensure -- from ANY
			deep_twin_not_void: Result /= Void
			deep_equal: deep_equal (