indexing
	description: "Stacks (Last-In, First-Out)"
	library: "Gobo Eiffel Structure Library"
	author: "Eric Bezault <ericb@gobo.demon.co.uk>"
	copyright: "Copyright (c) 1997, Eric Bezault"

deferred class interface
	DS_STACK [G]

feature -- Access

	item: G
			-- Item in structure
			-- (from DS_EXTENDIBLE)
		require -- from DS_EXTENDIBLE
			not_empty: not is_empty

	searcher: DS_SEARCHER [G]
			-- Structure searcher
			-- (from DS_SEARCHABLE)
	
feature -- Measurement

	count: INTEGER
			-- Number of items in structure
			-- (from DS_CONTAINER)

	occurrences (v: G): INTEGER
			-- Number of times v appears in structure
			-- (Use searcher's comparison criterion.)
			-- (from DS_SEARCHABLE)
		ensure -- from DS_SEARCHABLE
			positive: Result >= 0;
			has: has (v) implies Result >= 1
	
feature -- Comparison

	is_equal (other: like Current): BOOLEAN
			-- Is current structure equal to other?
			-- (from DS_CONTAINER)
		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
		ensure then -- from DS_CONTAINER
			same_count: Result implies count = other.count
		ensure then -- from DS_CONTAINER
			same_count: Result implies count = other.count
	
feature -- Status report

	extendible (n: INTEGER): BOOLEAN
			-- May structure be extended with n items?
			-- (from DS_EXTENDIBLE)
		require -- from DS_EXTENDIBLE
			positive_n: n >= 0

	has (v: G): BOOLEAN
			-- Does structure incluse v?
			-- (Use searcher's comparison criterion.)
			-- (from DS_SEARCHABLE)
		ensure -- from DS_SEARCHABLE
			not_empty: Result implies not is_empty

	is_empty: BOOLEAN
			-- Is structure empty?
			-- (from DS_CONTAINER)
	
feature -- Element change

	append (other: DS_LINEAR [G])
			-- Add items of other to structure.
			-- (from DS_EXTENDIBLE)
		require -- from DS_EXTENDIBLE
			other_not_void: other /= void
		ensure -- from DS_EXTENDIBLE
			new_count: count = old count + other.count

	extend (other: DS_LINEAR [G])
			-- Add items of other to structure.
			-- (from DS_EXTENDIBLE)
		require -- from DS_EXTENDIBLE
			other_not_void: other /= void;
			extendible: extendible (other.count)
		ensure -- from DS_EXTENDIBLE
			new_count: count = old count + other.count

	force (v: G)
			-- Push v on stack.
		ensure -- from DS_EXTENDIBLE
			one_more: count = old count + 1
		ensure then
			pushed: item = v

	put (v: G)
			-- Push v on stack.
		require -- from DS_EXTENDIBLE
			extendible: extendible (1)
		ensure -- from DS_EXTENDIBLE
			one_more: count = old count + 1
		ensure then
			pushed: item = v

	replace (v: G)
			-- Replace top item by v.
		require
			not_empty: not is_empty
		ensure
			same_count: count = old count;
			replaced: item = v
	
feature -- Removal

	keep (n: INTEGER)
			-- Keep n items in structure.
			-- (from DS_EXTENDIBLE)
		require -- from DS_EXTENDIBLE
			valid_n: 0 <= n and n <= count
		ensure -- from DS_EXTENDIBLE
			new_count: count = n

	prune (n: INTEGER)
			-- Remove n items from structure.
			-- (from DS_EXTENDIBLE)
		require -- from DS_EXTENDIBLE
			valid_n: 0 <= n and n <= count
		ensure -- from DS_EXTENDIBLE
			new_count: count = old count - n

	remove
			-- Remove an item from structure.
			-- (from DS_EXTENDIBLE)
		require -- from DS_EXTENDIBLE
			not_empty: not is_empty
		ensure -- from DS_EXTENDIBLE
			one_less: count = old count - 1

	wipe_out
			-- Remove all items from structure.
			-- (from DS_CONTAINER)
		ensure -- from DS_CONTAINER
			wipe_out: is_empty
		ensure -- from DS_CONTAINER
			wipe_out: is_empty
	
feature -- Setting

	set_searcher (a_searcher: like searcher)
			-- Set searcher to a_searcher.
			-- (from DS_SEARCHABLE)
		require -- from DS_SEARCHABLE
			a_searcher_not_void: a_searcher /= void
		ensure -- from DS_SEARCHABLE
			searcher_set: searcher = a_searcher
	
invariant

		-- from GENERAL
	reflexive_equality: standard_is_equal (Current);
	reflexive_conformance: conforms_to (Current);
		-- from DS_CONTAINER
	positive_count: count >= 0;
	empty_definition: is_empty = (count = 0);
		-- from DS_SEARCHABLE
	searcher_not_void: searcher /= void;

end -- class DS_STACK