indexing
description: "Stacks implemented by resizable arrays"
names: dispenser, array
representation: array
access: fixed, lifo, membership
size: fixed
contents: generic
class interface
ARRAYED_STACK [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
feature {ANY} -- Initialization
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
feature -- Access
has (v: like item): BOOLEAN
-- Does chain include v?
-- (Reference or object equality,
-- based on object_comparison.)
-- (from CHAIN)
ensure -- from CONTAINER
not_found_in_empty: Result implies not empty
item: like first
-- Current item
-- (from ARRAYED_LIST)
require -- from TRAVERSABLE
not_off: not off
require else -- from ARRAYED_LIST
index_is_valid: valid_index (index)
require -- from ACTIVE
readable: readable
require else -- from ARRAYED_LIST
index_is_valid: valid_index (index)
occurrences (v: like item): INTEGER
-- Number of times v appears.
-- (Reference or object equality,
-- based on object_comparison.)
-- (from CHAIN)
ensure -- from BAG
non_negative_occurrences: Result >= 0
occurrences (v: like item): INTEGER
-- Number of times v appears.
-- (Reference or object equality,
-- based on object_comparison.)
-- (from CHAIN)
ensure -- from BAG
non_negative_occurrences: Result >= 0
feature -- Measurement
count: INTEGER
-- Number of items.
-- (from ARRAYED_LIST)
feature -- Comparison
is_equal (other: like Current): BOOLEAN
--Is other equal to Current?
-- (from ARRAYED_LIST)
require -- from GENERAL
other_not_void: other /= void
ensure -- from GENERAL
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)
empty: BOOLEAN
-- Is structure empty?
-- (from FINITE)
Extendible: BOOLEAN is true
-- May new items be added? (Answer: yes.)
-- (from DYNAMIC_CHAIN)
full: BOOLEAN
-- Is structure filled to capacity? (Answer: no.)
-- (from ARRAYED_LIST)
object_comparison: BOOLEAN
-- Must search operations use equal rather than =
-- for comparing references? (Default: no, use =.)
-- (from CONTAINER)
prunable: BOOLEAN
-- May items be removed? (Answer: yes.)
-- (from ARRAYED_LIST)
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)
require -- from SEQUENCE
argument_not_void: s /= void
ensure -- from SEQUENCE
new_count: count >= old count
extend (v: like item)
-- Push v on top.
-- Was declared in ARRAYED_STACK as synonym of extend, put and force.
require -- from COLLECTION
extendible: extendible
ensure -- from COLLECTION
item_inserted: has (v)
ensure then -- from BAG
one_more_occurrence: occurrences (v) = old (occurrences (v)) + 1
ensure then -- from STACK
item_pushed: item = v
fill (other: LINEAR [G])
-- Fill with as many items of other as possible.
-- Fill items with greatest index from other first.
-- Items inserted with lowest index (from other) will
-- always be on the top of stack.
-- The representations of other and current structure
-- need not be the same.
-- (from STACK)
require -- from COLLECTION
other_not_void: other /= void;
extendible
force (v: like item)
-- Push v on top.
-- Was declared in ARRAYED_STACK as synonym of extend, put and force.
ensure then -- from STACK
item_pushed: item = v
put (v: like item)
-- Push v on top.
-- Was declared in ARRAYED_STACK as synonym of extend, put and force.
require -- from COLLECTION
extendible: extendible
ensure -- from COLLECTION
item_inserted: has (v)
ensure then -- from STACK
item_pushed: item = v
replace (v: like first)
-- Replace current item by v.
-- (from ARRAYED_LIST)
require -- from ACTIVE
writable: writable
ensure -- from ACTIVE
item_replaced: item = v
feature -- Removal
remove
-- Remove top item.
require -- from ACTIVE
prunable: prunable;
writable: writable
require else
not_empty: count /= 0
wipe_out
-- Remove all items.
-- (from ARRAYED_LIST)
require -- DYNAMIC_LIST
precursor: True
require -- from COLLECTION
prunable
ensure -- from COLLECTION
wiped_out: empty
feature -- Conversion
linear_representation: ARRAYED_LIST [G]
-- Representation as a linear structure
-- (in the reverse order of original insertion)
feature -- Duplication
copy (other: like Current)
-- (from ARRAYED_LIST)
require -- from GENERAL
other_not_void: other /= void;
type_identity: same_type (other)
ensure -- from GENERAL
is_equal: is_equal (other)
setup (other: like Current)
-- Prepare current object so that other
-- can be easily copied into it.
-- It is not necessary to call setup
-- (since consistent is always true)
-- but it will make copying quicker.
-- (from ARRAYED_LIST)
ensure -- from GENERAL
consistent (other)
invariant
-- from GENERAL
reflexive_equality: standard_is_equal (Current);
reflexive_conformance: conforms_to (Current);
-- from DISPENSER
readable_definition: readable = not empty;
writable_definition: writable = not empty;
-- from ACTIVE
writable_constraint: writable implies readable;
empty_constraint: empty implies (not readable) and (not writable);
-- from FINITE
empty_definition: empty = (count = 0);
non_negative_count: count >= 0;
-- from ARRAYED_LIST
prunable: prunable;
-- from ARRAY
non_negative_count: count >= 0;
-- from DYNAMIC_CHAIN
extendible: extendible;
end -- class ARRAYED_STACK