Automatic generation produced by ISE Eiffel
indexing description: "Sets represented as arrayed lists" status: "See notice at end of class" names: arrayed_set, set, arrayed_list representation: array size: fixed access: membership contents: generic date: "$Date: 2001-11-16 20:32:23 +0000 (Fri, 16 Nov 2001) $" revision: "$Revision: 51435 $" class interface ARRAYED_SET [G] create make (n: INTEGER) -- Allocate list with n items. -- (n may be zero for empty list.) -- (from ARRAYED_LIST) require -- from ARRAYED_LIST valid_number_of_items: n >= 0 ensure -- from ARRAYED_LIST correct_position: before feature -- Access has (v: G): BOOLEAN -- Does v appear in array? -- (Reference or object equality, -- based on object_comparison.) -- (from ARRAY) ensure -- from CONTAINER not_found_in_empty: Result implies not is_empty index: INTEGER -- Index of item, if valid. -- (from ARRAYED_LIST) item: like first -- Current item -- (from ARRAYED_LIST) require -- from TRAVERSABLE not_off: not off require -- from ACTIVE readable: readable require -- from TRAVERSABLE_SUBSET not_off: not off require else -- from ARRAYED_LIST index_is_valid: valid_index (index) feature -- Measurement count: INTEGER -- Number of items. -- (from ARRAYED_LIST) 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_equal (other: like Current): BOOLEAN -- Does other contain the same elements? -- (from LIST) 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 ensure then -- from LIST indices_unchanged: index = old index and other.index = old other.index true_implies_same_size: Result implies count = other.count 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 there no valid cursor position to the right of cursor? -- (from LIST) before: BOOLEAN -- Is there no valid cursor position to the left of cursor? -- (from LIST) Extendible: BOOLEAN is True -- May new items be added? (Answer: yes.) -- (from DYNAMIC_CHAIN) is_empty: BOOLEAN -- Is structure empty? -- (from FINITE) 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 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 CHAIN) prunable: BOOLEAN -- May items be removed? (Answer: yes.) -- (from ARRAYED_LIST) valid_index (i: INTEGER): BOOLEAN -- Is i a valid index? -- (from ARRAYED_LIST) 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)) ensure -- from LINEAR_SUBSET index_valid: 0 <= n and n <= count + 1 valid_index (i: INTEGER): BOOLEAN -- Is i a valid index? -- (from ARRAYED_LIST) 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)) ensure -- from LINEAR_SUBSET 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 one position forward. -- (from ARRAYED_LIST) require -- from LINEAR not_after: not after require -- from TRAVERSABLE_SUBSET not_after: not after ensure then -- from LIST moved_forth: index = old index + 1 go_i_th (i: INTEGER) -- Move cursor to i-th position. -- (from ARRAYED_LIST) require -- from CHAIN valid_cursor_index: valid_cursor_index (i) require -- from LINEAR_SUBSET valid_index: valid_index (i) ensure -- from CHAIN position_expected: index = i ensure -- from LINEAR_SUBSET cursor_moved: index = i start -- Move cursor to first position if any. -- (from ARRAYED_LIST) ensure then -- from CHAIN at_first: not is_empty implies isfirst ensure then -- from ARRAYED_LIST after_when_empty: is_empty implies after feature -- Element change extend (v: G) -- Insert v if not present. -- Was declared in ARRAYED_SET as synonym of put. 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. -- (from LINEAR_SUBSET) require -- from LINEAR_SUBSET item_exists: v /= void item_in_set: has (v) put (v: G) -- Insert v if not present. -- Was declared in ARRAYED_SET as synonym of extend. 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: like item) -- Add v to the left of current position. -- Do not move cursor. -- (from ARRAYED_LIST) require -- from DYNAMIC_CHAIN extendible: extendible not_before: not before require -- from LINEAR_SUBSET item_exists: v /= void not_before: not before ensure -- from DYNAMIC_CHAIN new_count: count = old count + 1 new_index: index = old index + 1 ensure -- from LINEAR_SUBSET 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: like item) -- Remove v if present. 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: like item) -- Remove all occurrences of v. -- (Reference or object equality, -- based on object_comparison.) -- (from ARRAYED_LIST) require -- from COLLECTION prunable ensure -- from COLLECTION no_more_occurrences: not has (v) ensure then -- from DYNAMIC_CHAIN is_exhausted: exhausted ensure then -- from ARRAYED_LIST is_after: after remove -- Remove current item. -- Move cursor to right neighbor -- (or after if no right neighbor) -- (from ARRAYED_LIST) require -- from ACTIVE prunable: prunable writable: writable require -- from TRAVERSABLE_SUBSET not_off: not off ensure then -- from DYNAMIC_LIST after_when_empty: is_empty implies after ensure then -- from ARRAYED_LIST index: index = old index wipe_out -- Remove all items. -- (from ARRAYED_LIST) require -- from COLLECTION prunable ensure -- from COLLECTION wiped_out: is_empty ensure then -- from DYNAMIC_LIST is_before: before feature -- Conversion linear_representation: LINEAR [G] -- Representation as a linear structure -- (from LINEAR) feature -- Duplication copy (other: like Current) -- Reinitialize by copying all the items of other. -- (This is also used by clone.) -- (from ARRAY) require -- from ANY other_not_void: other /= void type_identity: same_type (other) ensure -- from ANY is_equal: is_equal (other) ensure then -- from ARRAY equal_areas: area.is_equal (other.area) duplicate (n: INTEGER): like Current -- Copy of sub-list beginning at current position -- and having min (n, count - index + 1) items. -- (from ARRAYED_LIST) require -- from CHAIN not_off_unless_after: off implies after valid_subchain: n >= 0 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 -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from LINEAR_SUBSET before_definition: before = (index = 0) -- from TRAVERSABLE_SUBSET empty_definition: is_empty = (count = 0) count_range: count >= 0 -- from ARRAYED_LIST prunable: prunable starts_from_one: lower = 1 empty_means_storage_empty: is_empty implies all_default -- from ARRAY area_exists: area /= void consistent_size: capacity = upper - lower + 1 non_negative_count: count >= 0 index_set_has_same_count: valid_index_set index_set_has_same_bounds: ((index_set.lower = lower) and (index_set.upper = lower + count - 1)) -- from RESIZABLE increase_by_at_least_one: minimal_increase >= 1 -- from BOUNDED valid_count: count <= capacity full_definition: full = (count = capacity) -- from FINITE empty_definition: is_empty = (count = 0) non_negative_count: count >= 0 -- from INDEXABLE index_set_not_void: index_set /= void -- from LIST before_definition: before = (index = 0) after_definition: after = (index = count + 1) -- from CHAIN non_negative_index: index >= 0 index_small_enough: index <= count + 1 off_definition: off = ((index = 0) or (index = count + 1)) isfirst_definition: isfirst = ((not is_empty) and (index = 1)) islast_definition: islast = ((not is_empty) and (index = count)) item_corresponds_to_index: (not off) implies (item = i_th (index)) index_set_has_same_count: index_set.count = count -- from ACTIVE writable_constraint: writable implies readable empty_constraint: is_empty implies (not readable) and (not writable) -- 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 DYNAMIC_CHAIN extendible: extendible 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 ARRAYED_SET -- Generated by ISE Eiffel --
For more details: www.eiffel.com