Automatic generation produced by ISE Eiffel
indexing description: "Priority queues implemented as heaps" status: "See notice at end of class" names: sorted_priority_queue, dispenser, heap representation: heap access: fixed, membership contents: generic date: "$Date: 2001-11-16 20:32:23 +0000 (Fri, 16 Nov 2001) $" revision: "$Revision: 51435 $" class interface HEAP_PRIORITY_QUEUE [G -> COMPARABLE] create make (n: INTEGER) -- Allocate heap space. feature -- Initialization make (n: INTEGER) -- Allocate heap space. 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 item: G -- Entry at top of heap. require -- from ACTIVE readable: readable feature -- Measurement count: INTEGER -- Number of items index_set: INTEGER_INTERVAL -- Range of acceptable indexes ensure -- from INDEXABLE not_void: Result /= void ensure then -- from ARRAY same_count: Result.count = count same_bounds: ((Result.lower = lower) and (Result.upper = upper)) ensure then count_definition: Result.count = count occurrences (v: G): INTEGER -- Number of times v appears in structure -- (from ARRAY) ensure -- from BAG non_negative_occurrences: Result >= 0 feature -- Comparison is_equal (other: like Current): BOOLEAN -- Is array made of the same items as other? -- (from ARRAY) 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 feature -- Status report changeable_comparison_criterion: BOOLEAN -- May object_comparison be changed? -- (Answer: yes by default.) -- (from CONTAINER) extendible: BOOLEAN -- May items be added? full: BOOLEAN -- Is structure filled to capacity? 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) object_comparison: BOOLEAN -- Must search operations use equal rather than = -- for comparing references? (Default: no, use =.) -- (from CONTAINER) Prunable: BOOLEAN is True -- May items be removed? (Answer: yes.) readable: BOOLEAN -- Is there a current item that may be read? -- (from DISPENSER) writable: BOOLEAN -- Is there a current item that may be modified? -- (from DISPENSER) 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 -- Element change append (s: SEQUENCE [G]) -- Append a copy of s. -- (Synonym for fill) -- (from DISPENSER) 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 force (v: like item) -- Insert item v at its proper position. -- Was declared in HEAP_PRIORITY_QUEUE as synonym of put. put (v: like item) -- Insert item v at its proper position. -- Was declared in HEAP_PRIORITY_QUEUE as synonym of force. require -- from COLLECTION extendible: extendible ensure -- from COLLECTION item_inserted: is_inserted (v) feature -- Removal 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 item of highest value. require -- from ACTIVE prunable: prunable writable: writable feature -- Conversion linear_representation: ARRAYED_LIST [G] -- Representation as a linear structure -- (Sorted according to decreasing priority) 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 -- New priority queue containing the n greatest items feature -- Inapplicable extend (v: G) -- Add v to structure. -- (Precondition is False.) -- (from ARRAY) 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 prune (v: G) -- Remove first occurrence of v if any. -- (Precondition is False.) -- (from ARRAY) require -- from COLLECTION prunable: prunable invariant empty_means_storage_empty: is_empty implies all_default -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from DISPENSER readable_definition: readable = not is_empty writable_definition: writable = not is_empty -- from ACTIVE writable_constraint: writable implies readable empty_constraint: is_empty implies (not readable) and (not writable) -- from FINITE empty_definition: is_empty = (count = 0) non_negative_count: count >= 0 -- 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 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 HEAP_PRIORITY_QUEUE -- Generated by ISE Eiffel --
For more details: www.eiffel.com