indexing
	description: "Unbounded queues, implemented by resizable arrays"
	status: "See notice at end of class"
	names: dispenser, array
	representation: array
	access: fixed, fifo, membership
	size: fixed
	contents: generic
	date: "$Date$"
	revision: "$Revision$"

class interface
	ARRAYED_QUEUE [G]

create

	make (n: INTEGER)
			-- Create queue for at most n items.
		require
			non_negative_argument: n >= 0
		ensure
			capacity_expected: capacity = n

feature -- Initialization

	make (n: INTEGER)
			-- Create queue for at most n items.
		require
			non_negative_argument: n >= 0
		ensure
			capacity_expected: capacity = n

feature -- Access

	has (v: like item): BOOLEAN
			-- Does queue include v?
			-- (Reference or object equality,
			-- based on object_comparison.)
		ensure -- from CONTAINER
			not_found_in_empty: Result implies not is_empty

	item: G
			-- Oldest item.
		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? (Answer: yes.)

	full: BOOLEAN
			-- Is structure filled to capacity?
			-- (Answer: no.)

	is_empty: BOOLEAN
			-- Is the structure empty?
			-- Was declared in ARRAYED_QUEUE as synonym of off.

	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 the structure empty?
			-- Was declared in ARRAYED_QUEUE as synonym of is_empty.

	prunable: BOOLEAN
			-- 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)

	extend (v: G)
			-- Add v as newest item.
			-- Was declared in ARRAYED_QUEUE as synonym of put and force.
		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

	force (v: G)
			-- Add v as newest item.
			-- Was declared in ARRAYED_QUEUE as synonym of extend and put.

	put (v: G)
			-- Add v as newest item.
			-- Was declared in ARRAYED_QUEUE as synonym of extend and force.
		require -- from COLLECTION
			extendible: extendible
		ensure -- from COLLECTION
			item_inserted: is_inserted (v)

	replace (v: like item)
			-- Replace oldest item by v.
		require -- from ACTIVE
			writable: writable
		ensure -- from ACTIVE
			item_replaced: item = v

feature -- Removal

	remove
			-- Remove oldest item.
		require -- from ACTIVE
			prunable: prunable
			writable: writable

	wipe_out
			-- Remove all items.
		require -- from COLLECTION
			prunable
		ensure -- from COLLECTION
			wiped_out: is_empty

feature -- Conversion

	linear_representation: ARRAYED_LIST [G]
			-- Representation as a linear structure
			-- (in the original insertion order)

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)

invariant

	not_full: not full
	extendible: extendible
	prunable: prunable
	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
		-- 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 ARRAYED_QUEUE