Automatic generation produced by ISE Eiffel
indexing description: "Structures whose items are sorted according to a total order relation" status: "See notice at end of class" names: sorted_struct, comparable_struct access: index, membership, min, max contents: generic date: "$Date: 2001-11-16 20:32:23 +0000 (Fri, 16 Nov 2001) $" revision: "$Revision: 51435 $" deferred class interface SORTED_STRUCT [G -> COMPARABLE] feature -- Access has (v: like item): BOOLEAN -- Does structure include an occurrence of v? -- (Reference or object equality, -- based on object_comparison.) -- (from LINEAR) ensure -- from CONTAINER not_found_in_empty: Result implies not is_empty index_of (v: like item; i: INTEGER): INTEGER -- 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 ensure -- from LINEAR non_negative_result: Result >= 0 item: G -- Item at current position -- (from TRAVERSABLE) require -- from TRAVERSABLE not_off: not off i_th (k: INTEGER): G -- Entry of key k. -- Was declared in TABLE as synonym of @. -- (from TABLE) require -- from TABLE valid_key: valid_index (k) occurrences (v: G): INTEGER -- Number of times v appears. -- (Reference or object equality, -- based on object_comparison.) -- (from LINEAR) ensure -- from BAG non_negative_occurrences: Result >= 0 search (v: like item) -- 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) 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 infix "@" (k: INTEGER): G -- Entry of key k. -- Was declared in TABLE as synonym of item. -- (from TABLE) require -- from TABLE valid_key: valid_index (k) feature -- Measurement index_set: INTEGER_INTERVAL -- Range of acceptable indexes -- (from INDEXABLE) ensure -- from INDEXABLE not_void: Result /= void max: like item -- Maximum item require -- from COMPARABLE_STRUCT min_max_available require else is_sorted: sorted median: like item -- Median element ensure median_present: has (Result) min: like item -- Minimum item require -- from COMPARABLE_STRUCT min_max_available require else is_sorted: sorted min_max_available: BOOLEAN -- Can min and max be computed? -- (from COMPARABLE_STRUCT) ensure -- from COMPARABLE_STRUCT Result implies not is_empty feature -- Status report after: BOOLEAN -- Is there no valid position to the right of current one? -- (from LINEAR) changeable_comparison_criterion: BOOLEAN -- May object_comparison be changed? -- (Answer: yes by default.) -- (from CONTAINER) exhausted: BOOLEAN -- Has structure been completely explored? -- (from LINEAR) ensure -- from LINEAR exhausted_when_off: off implies Result extendible: BOOLEAN -- May new items be added? -- (from COLLECTION) is_empty: BOOLEAN -- Is there no element? -- (from CONTAINER) 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) 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 LINEAR) prunable: BOOLEAN -- May items be removed? -- (from COLLECTION) sorted: BOOLEAN -- Is structure sorted? valid_index (i: INTEGER): BOOLEAN -- Is i a valid index? -- (from INDEXABLE) ensure then -- from INDEXABLE only_if_in_index_set: Result implies ((i >= index_set.lower) and (i <= index_set.upper)) 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 back -- Move to previous position. -- (from BILINEAR) require -- from BILINEAR not_before: not before before: BOOLEAN -- Is there no valid position to the left of current one? -- (from BILINEAR) finish -- Move to last position. -- (from LINEAR) forth -- Move to next position; if no next position, -- ensure that exhausted will be true. -- (from LINEAR) require -- from LINEAR not_after: not after start -- Move to first position if any. -- (from TRAVERSABLE) feature -- Element change 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 COLLECTION) require -- from COLLECTION other_not_void: other /= void extendible put_i_th (v: G; k: INTEGER) -- Associate value v with key k. -- (from INDEXABLE) require -- from TABLE valid_key: valid_index (k) ensure then -- from INDEXABLE insertion_done: i_th (k) = v feature -- Removal prune (v: G) -- Remove one occurrence of v if any. -- (Reference or object equality, -- based on object_comparison.) -- (from COLLECTION) require -- from COLLECTION prunable: prunable 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) wipe_out -- Remove all items. -- (from COLLECTION) require -- from COLLECTION prunable ensure -- from COLLECTION wiped_out: is_empty feature -- Transformation sort -- Sort structure. ensure is_sorted: sorted feature -- Conversion linear_representation: LINEAR [G] -- Representation as a linear structure -- (from LINEAR) feature -- Inapplicable index: INTEGER -- (from COMPARABLE_STRUCT) feature -- Iteration do_all (action: PROCEDURE [ANY, TUPLE [G]]) -- 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 do_if (action: PROCEDURE [ANY, TUPLE [G]]; test: FUNCTION [ANY, TUPLE [G], BOOLEAN]) -- 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 for_all (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]): BOOLEAN -- Is test true for all items? -- (from LINEAR) require -- from TRAVERSABLE test_exits: test /= void there_exists (test: FUNCTION [ANY, TUPLE [G], BOOLEAN]): BOOLEAN -- Is test true for at least one item? -- (from LINEAR) require -- from TRAVERSABLE test_exits: test /= void invariant -- 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 INDEXABLE index_set_not_void: index_set /= void 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 SORTED_STRUCT -- Generated by ISE Eiffel --
For more details: www.eiffel.com