+
Point of view
All features
class QUEUE [E_]
Summary
top
A Queue of elements of type E_.
Direct parents
Insert list: ANY, RING_ARRAY
Class invariant
top
Overview
top
Creation features
{ANY}
  • make
    Create an empty array.
  • with_capacity (needed_capacity: INTEGER_32)
    Create an empty array with capacity initialized at least to needed_capacity
{ANY}
Features
{}
{}
{ANY}
Modification:
{ANY}
Implementation of deferred:
{ANY}
{}
{ANY}
{RING_ARRAY}
Garbage collector tuning (very low-level):
{}
  • mark_native_arrays
    For performance reasons, the unused area of storage is always left as it is when some elements are removed.
Implement manifest generic creation (very low-level):
{}
Accessing:
{ANY}
Writing:
{ANY}
Adding:
{ANY}
Removing:
{ANY}
Looking and Searching:
{ANY}
Looking and comparison:
{ANY}
Other features:
{ANY}
Implement manifest generic creation:
{}
{ANY}
Other features:
{ANY}
Agent-based features:
{ANY}
Printing:
{ANY}
{ANY}
{}
Agent-based features:
{ANY}
{}
Indexing:
{ANY}
Accessing:
{ANY}
{ARRAYED_COLLECTION, ARRAYED_COLLECTION_HANDLER}
{ANY}
{ARRAYED_COLLECTION}
{}
make
effective procedure
{}
top
Create an empty array.
Also consider with_capacity, since growing a full queue is rather expensive.
ensure
with_capacity (needed_capacity: INTEGER_32)
effective procedure
{}
top
Create an empty array with capacity initialized at least to needed_capacity
require
  • needed_capacity >= 0
new_iterator: ITERATOR[E_]
effective function
{}
top
ensure
  • Result /= Void
  • Result.generation = generation
default_create
effective procedure
{}
top
Default creation method.
It is used when no creation method is specified if allowed. Note it may be renamed.
lower: INTEGER_32
writable attribute
{ANY}
top
Lower index bound
resize (min_index: INTEGER_32, max_index: INTEGER_32)
effective procedure
{ANY}
top
Resize to bounds min_index and max_index.
Do not lose any item whose index is in both [lower .. upper] and [min_index .. max_index]. New positions if any are initialized with the appropriate default value.
require
  • min_index <= max_index + 1
ensure
reindex (new_lower: INTEGER_32)
effective procedure
{ANY}
top
Change indexing to take in account the expected new_lower index.
The upper index is translated accordingly.
ensure
count: INTEGER_32
effective function
{ANY}
top
Number of available items in the hoard.
See also is_empty
ensure
  • Result >= 0
is_empty: BOOLEAN
effective function
{ANY}
top
Is the hoard empty ?
See also count.
ensure
  • definition: Result = count = 0
subarray (min: INTEGER_32, max: INTEGER_32): QUEUE [E_]
effective function
{ANY}
top
New collection consisting of items at indexes in [min .. max].
Result has the same dynamic type as Current. See also slice.
require
  • lower <= min
  • max <= upper
  • min <= max + 1
ensure
  • Result.lower = min
  • same_dynamic_type(Result)
  • Result.count = max - min + 1
  • Result.lower = min or Result.lower = 0
item (i: INTEGER_32): E_
effective function
{ANY}
top
Item at the corresponding index i.
See also lower, upper, valid_index.
require
      • valid_index(i)
      • valid_index(i)
      • valid_index(i)
      • valid_index(i)
put (element: E_, i: INTEGER_32)
effective procedure
{ANY}
top
Make element the item at index i.
See also lower, upper, valid_index, item, swap, force.
require
    • valid_index(i)
    • valid_index(i)
ensure
  • item(i) = element
  • count = old count
force (element: E_, index: INTEGER_32)
effective procedure
{ANY}
top
Make element the item at index, enlarging the collection if necessary (new bounds except index are initialized with default values).
See also put, item, swap.
require(
  • True
) or else (
    • index >= lower
) ensure
  • lower = index.min(old lower)
  • upper = index.max(old upper)
  • item(index) = element
copy (other: QUEUE [E_])
effective procedure
{ANY}
top
Reinitialize by copying all the items of other.
require
      • not immutable
      • same_dynamic_type(other)
        • not immutable
        • same_dynamic_type(other)
        • not immutable
        • same_dynamic_type(other)
    • not immutable
    • same_dynamic_type(other)
ensure
  • is_equal(other)
set_all_with (v: E_)
effective procedure
{ANY}
top
Set all items with value v.
See also set_slice_with.
ensure
  • count = old count
remove_first
effective procedure
{ANY}
top
Remove the first element of the collection.
See also remove_last, collection_remove, remove_head.
require
    • not is_empty
    • not is_empty
ensure
  • upper = old upper
  • count = old count - 1
  • lower = old lower + 1 xor upper = old upper - 1
remove_head (n: INTEGER_32)
effective procedure
{ANY}
top
Remove the n elements of the collection.
See also remove_tail, collection_remove, remove.
require
    • n > 0 and n <= count
    • n > 0 and n <= count
ensure
  • upper = old upper
  • count = old count - n
  • lower = old lower + n xor upper = old upper - n
remove (index: INTEGER_32)
effective procedure
{ANY}
top
Remove the item at position index.
Followings items are shifted left by one position.
See also remove, remove_head, remove_tail, remove_last.
require
    • valid_index(index)
    • valid_index(index)
ensure
  • count = old count - 1
  • upper = old upper - 1
clear_count
effective procedure
{ANY}
top
Discard all items (is_empty is True after that call).
If possible, the actual implementation supposed to keep its internal storage area in order to refill Current in an efficient way.
See also clear_count_and_capacity.
ensure
clear_count_and_capacity
effective procedure
{ANY}
top
Discard all items (is_empty is True after that call).
If possible, the actual implementation supposed to release its internal storage area for this memory to be used by other objects.
See also clear_count.
ensure
add_first (element: E_)
effective procedure
{ANY}
top
Add a new item in first position : count is increased by one and all other items are shifted right.
See also add, first, last, collection_add.
ensure
  • first = element
  • count = 1 + old count
  • lower = old lower
  • upper = 1 + old upper
add_last (element: E_)
effective procedure
{ANY}
top
Add a new item at the end : count is increased by one.
See also add_first, last, first, collection_add.
ensure
  • last = element
  • count = 1 + old count
  • lower = old lower
  • upper = 1 + old upper
from_collection (model: TRAVERSABLE[E_])
effective procedure
{ANY}
top
Initialize the current object with the contents of model.
require
    • model /= Void
    • useful_work: model /= Current
    • model /= Void
    • useful_work: model /= Current
ensure
  • lower = model.lower
  • upper = model.upper
  • count = model.count
all_default: BOOLEAN
effective function
{ANY}
top
Do all items have their type's default value?
Note: for non Void items, the test is performed with the is_default predicate.
See also clear_all.
occurrences (element: E_): INTEGER_32
effective function
{ANY}
top
Number of occurrences of element using is_equal for comparison.
See also fast_occurrences, index_of.
ensure
  • Result >= 0
fast_occurrences (element: E_): INTEGER_32
effective function
{ANY}
top
Number of occurrences of element using basic = for comparison.
See also occurrences, index_of.
ensure
  • Result >= 0
first_index_of (element: E_): INTEGER_32
effective function
{ANY}
top
Give the index of the first occurrence of element using is_equal for comparison.
Answer upper + 1 when element is not inside.
See also fast_first_index_of, index_of, last_index_of, reverse_index_of.
ensure
  • definition: Result = index_of(element, lower)
index_of (element: E_, start_index: INTEGER_32): INTEGER_32
effective function
{ANY}
top
Using is_equal for comparison, gives the index of the first occurrence of element at or after start_index.
Return upper + 1 if the search for element failed.
See also fast_index_of, reverse_index_of, first_index_of.
ensure
  • Result.in_range(start_index, upper + 1)
  • valid_index(Result) implies (create {SAFE_EQUAL}).test(element, item(Result))
reverse_index_of (element: E_, start_index: INTEGER_32): INTEGER_32
effective function
{ANY}
top
Using is_equal for comparison, gives the index of the first occurrence of element at or before start_index.
Search is done in reverse direction, which means from the start_index down to the lower index . Answer lower -1 when the search fail.
See also fast_reverse_index_of, last_index_of, index_of.
require
    • valid_index(start_index)
    • valid_index(start_index)
ensure
  • Result.in_range(lower - 1, start_index)
  • valid_index(Result) implies item(Result).is_equal(element)
fast_first_index_of (element: E_): INTEGER_32
effective function
{ANY}
top
Give the index of the first occurrence of element using basic = for comparison.
Answer upper + 1 when element is not inside.
See also first_index_of, last_index_of, fast_last_index_of.
ensure
  • definition: Result = fast_index_of(element, lower)
fast_index_of (element: E_, start_index: INTEGER_32): INTEGER_32
effective function
{ANY}
top
Using basic = for comparison, gives the index of the first occurrence of element at or after start_index.
Answer upper + 1 when element when the search fail.
See also index_of, fast_reverse_index_of, fast_first_index_of.
ensure
  • Result.in_range(start_index, upper + 1)
  • valid_index(Result) implies element = item(Result)
fast_reverse_index_of (element: E_, start_index: INTEGER_32): INTEGER_32
effective function
{ANY}
top
Using basic = comparison, gives the index of the first occurrence of element at or before start_index.
Search is done in reverse direction, which means from the start_index down to the lower index . Answer lower -1 when the search fail.
See also reverse_index_of, fast_index_of, fast_last_index_of.
require
    • valid_index(start_index)
    • valid_index(start_index)
ensure
  • Result.in_range(lower - 1, start_index)
  • valid_index(Result) implies item(Result) = element
fast_is_equal (other: QUEUE [E_]): BOOLEAN
effective function
{ANY}
top
Do both collections have the same lower, upper, and items?
The basic = is used for comparison of items.
See also is_equal, same_items.
ensure
  • Result implies lower = other.lower and upper = other.upper
is_equal (other: QUEUE [E_]): BOOLEAN
effective function
{ANY}
top
Do both collections have the same lower, upper, and items?
Feature is_equal is used for comparison of items.
See also fast_is_equal, same_items.
require
      • other /= Void
        • other /= Void
        • other /= Void
    • other /= Void
ensure
  • Result implies lower = other.lower and upper = other.upper
  • commutative: generating_type = other.generating_type implies Result = other.is_equal(Current)
slice (min: INTEGER_32, max: INTEGER_32): QUEUE [E_]
effective function
{ANY}
top
New collection consisting of items at indexes in [min..max].
Result has the same dynamic type as Current. The lower index of the Result is the same as lower.
See also from_collection, move, replace_all.
require
    • lower <= min
    • max <= upper
    • min <= max + 1
    • lower <= min
    • max <= upper
    • min <= max + 1
ensure
  • same_dynamic_type(Result)
  • Result.count = max - min + 1
  • Result.lower = lower
first: E_
effective function
{ANY}
top
The very first item.
See also last, item.
require
      • not is_empty
      • not is_empty
      • not is_empty
      • not is_empty
ensure
  • definition: Result = item(lower)
make_space_for_one
effective procedure
{}
top
Make sure storage is big enough to hold at least one more element.
clear_slice (min: INTEGER_32, max: INTEGER_32)
effective procedure
{}
top
require
squeeze_bubble (min: INTEGER_32, max: INTEGER_32, pos: INTEGER_32, length: INTEGER_32)
effective procedure
{}
top
require
unwrap
effective procedure
{}
top
ensure
to_external: POINTER
effective function
{ANY}
top
Gives C access into the internal storage of the ARRAY.
Result is pointing the element at index lower.
NOTE: do not free/realloc the Result. Any operation that changes 
      lower or upper can make this pointer useless (because the
      array has wrapped or its beginning in the storage has moved),
      and operations that change capacity can make it invalid
      (because new memory has been allocated and the old memory has
      been freed)
require
  • not is_empty
ensure
is_wrapped: BOOLEAN
effective function
{ANY}
top
ensure
storage_lower: INTEGER_32
writable attribute
{RING_ARRAY}
top
Index of first in storage This would always be 0 for regular arrays.
storage_upper: INTEGER_32
effective function
{RING_ARRAY}
top
Index of last in storage
require ensure
storage_index (i: INTEGER_32): INTEGER_32
effective function
{RING_ARRAY}
top
Index in storage corresponding to index i in Current
require ensure
in_storage (index: INTEGER_32): BOOLEAN
effective function
{RING_ARRAY}
top
ensure
  • Result = 0 <= index and index < capacity
wrap_point: INTEGER_32
effective function
{RING_ARRAY}
top
Index in Current (seen as a COLLECTION) such that for any valid_indexes i and j, if i < wrap_point and j >= wrap_point then storage_index(i) > storage_index(j)
This can happen because of the circular nature of the array.
wrap_point is not a valid_index if and only if there is no such point (i.e. the array doesn't wrap).
ensure
slices_are_equal (other: QUEUE [E_], wp: INTEGER_32, owp: INTEGER_32): BOOLEAN
effective function
{RING_ARRAY}
top
require
slices_are_equal_map (other: QUEUE [E_], wp: INTEGER_32, owp: INTEGER_32): BOOLEAN
effective function
{RING_ARRAY}
top
require
mark_native_arrays
effective procedure
{}
top
For performance reasons, the unused area of storage is always left as it is when some elements are removed.
No time is lost to clean the released area with a Void or a 0 value. (Look for example the remove_last implementation.) Thus, the unused area of storage may contains references of actually unreachable objects. The following mark_native_arrays actually replace the default behavior (the call is automatic) in order to mark only reachable objects.
manifest_make (needed_capacity: INTEGER_32, initial_lower: INTEGER_32)
effective procedure
{}
top
Manifest creation of a RING_ARRAY lower set to initial_lower.
manifest_put (index: INTEGER_32, element: E_)
effective procedure
{}
top
require
    • index >= 0
    • index >= 0
ensure
infix "@" (i: INTEGER_32): E_
frozen
effective function
{ANY}
top
The infix notation which is actually just a synonym for item.
See also item.
require ensure
  • definition: Result = item(i)
swap (i1: INTEGER_32, i2: INTEGER_32)
effective procedure
{ANY}
top
Swap item at index i1 with item at index i2.
See also item, put.
require ensure
set_slice_with (v: ANY, lower_index: INTEGER_32, upper_index: INTEGER_32)
effective procedure
{ANY}
top
Set all items in range [lower_index .. upper_index] with v.
See also set_all_with.
require ensure
clear_all
effective procedure
{ANY}
top
Set every item to its default value.
The count is not affected.
See also clear, all_default.
ensure
add (element: ANY, index: INTEGER_32)
deferred procedure
{ANY}
top
Add a new element at rank index : count is increased by one and range [index .. upper] is shifted right by one position.
See also add_first, add, append_collection.
require ensure
append_collection (other: COLLECTION[E_])
effective procedure
{ANY}
top
Append other to Current.
This feature is obsolete: Use `append_traversable' instead.
append_traversable (other: TRAVERSABLE[E_])
effective procedure
{ANY}
top
Append other to Current.
See also add, add_first, collection_add.
require
  • other /= Void
ensure
remove_last
deferred procedure
{ANY}
top
Remove the last item.
See also remove, collection_remove, remove_tail.
require ensure
remove_tail (n: INTEGER_32)
deferred procedure
{ANY}
top
Remove the last n item(s).
See also remove_head, collection_remove, remove_last.
require ensure
has (x: ANY): BOOLEAN
effective function
{ANY}
top
Look for x using is_equal for comparison.
See also fast_has, index_of, fast_index_of.
ensure
  • definition: Result = valid_index(first_index_of(x))
fast_has (x: ANY): BOOLEAN
effective function
{ANY}
top
Look for x using basic = for comparison.
See also has, fast_index_of, index_of.
ensure
  • definition: Result = valid_index(fast_first_index_of(x))
last_index_of (element: ANY): INTEGER_32
effective function
{ANY}
top
Using is_equal for comparison, gives the index of the last occurrence of element at or before upper.
Search is done in reverse direction, which means from the upper down to the lower index . Answer lower -1 when the search fail.
See also fast_last_index_of, reverse_index_of, index_of.
ensure
  • definition: Result = reverse_index_of(element, upper)
fast_last_index_of (element: ANY): INTEGER_32
effective function
{ANY}
top
Using basic = for comparison, gives the index of the last occurrence of element at or before upper.
Search is done in reverse direction, which means from the upper down to the lower index . Answer lower -1 when the search fail.
See also fast_reverse_index_of, last_index_of.
ensure
  • definition: Result = fast_reverse_index_of(element, upper)
is_equal_map (other: QUEUE [E_]): BOOLEAN
effective function
{ANY}
top
Do both collections have the same lower, upper, and items?
This feature is obsolete: Use `is_equal' instead.
same_items (other: COLLECTION[E_]): BOOLEAN
effective function
{ANY}
top
Do both collections have the same items?
The basic = is used for comparison of items and indices are not considered (for example this routine may yield True with Current indexed in range [1..2] and other indexed in range [2..3]).
See also is_equal, fast_is_equal.
require
  • other /= Void
ensure
replace_all (old_value: ANY, new_value: ANY)
deferred procedure
{ANY}
top
Replace all occurrences of the element old_value by new_value using is_equal for comparison.
See also fast_replace_all, move.
ensure
fast_replace_all (old_value: ANY, new_value: ANY)
deferred procedure
{ANY}
top
Replace all occurrences of the element old_value by new_value using basic = for comparison.
See also replace_all, move.
ensure
move (lower_index: INTEGER_32, upper_index: INTEGER_32, distance: INTEGER_32)
effective procedure
{ANY}
top
Move range lower_index ..
upper_index by distance positions. Negative distance moves towards lower indices. Free places get default values.
See also slice, replace_all.
require ensure
reverse
deferred procedure
{ANY}
top
Reverse the order of the elements.
ensure
manifest_semicolon_check: BOOLEAN
is False
constant attribute
{}
top
enumerate: ENUMERATE[E_]
effective function
{ANY}
top
get_new_iterator: ITERATOR[E_]
frozen
effective function
{ANY}
top
This feature is obsolete: Use `new_iterator' instead. This historical SmartEiffel feature is badly named.
for_each (action: PROCEDURE[TUPLE[TUPLE 1[E_]]])
effective procedure
{ANY}
top
Apply action to every item of Current.
See also for_all, exists, aggregate.
require
  • action /= Void
for_all (test: FUNCTION[TUPLE[TUPLE 1[E_]]]): BOOLEAN
effective function
{ANY}
top
Do all items satisfy test?
See also for_each, exists, aggregate.
require
  • test /= Void
exists (test: FUNCTION[TUPLE[TUPLE 1[E_]]]): BOOLEAN
effective function
{ANY}
top
Does at least one item satisfy test?
See also for_each, for_all, aggregate.
require
  • test /= Void
aggregate (action: FUNCTION[TUPLE[TUPLE 2[E_, E_], E_]], initial: E_): E_
effective function
{ANY}
top
Aggregate all the elements starting from the initial value.
See also for_each, for_all, exists.
require
  • action /= Void
out_in_tagged_out_memory
effective procedure
{ANY}
top
Append terse printable representation of current object in tagged_out_memory.
require
  • locked: tagged_out_locked
ensure
  • still_locked: tagged_out_locked
  • not_cleared: tagged_out_memory.count >= old tagged_out_memory.count
  • append_only: old tagged_out_memory.twin.is_equal(tagged_out_memory.substring(1, old tagged_out_memory.count))
generation: INTEGER_32
writable attribute
{ANY}
top
next_generation
effective procedure
{}
top
ensure
do_all (action: ROUTINE[TUPLE[TUPLE 1[E_]]])
frozen
effective procedure
{ANY}
top
Apply action to every item of Current.
This feature is obsolete: Use `for_each` instead. This feature is not secure because it accepts a FUNCTION, the result of which is lost.
_inline_agent1 (a: ROUTINE[TUPLE[TUPLE 1[E_]]], e: E_)
frozen
effective procedure
{}
top
upper: INTEGER_32
deferred function
{ANY}
top
Maximum index.
See also lower, valid_index, item.
valid_index (i: INTEGER_32): BOOLEAN
effective function
{ANY}
top
True when i is valid (i.e., inside actual bounds).
See also lower, upper, item.
ensure
last: E_
deferred function
{ANY}
top
The last item.
See also first, item.
require ensure
storage: NATIVE_ARRAY[E_]
writable attribute
{ARRAYED_COLLECTION, ARRAYED_COLLECTION_HANDLER}
top
Internal access to storage location.
from_external (a_storage: POINTER, a_capacity: INTEGER_32)
effective procedure
{ARRAYED_COLLECTION, ARRAYED_COLLECTION_HANDLER}
top
require
  • a_capacity > 0 implies a_storage.is_not_null
ensure
capacity: INTEGER_32
writable attribute
{ANY}
top
Internal storage capacity in number of item.
set_upper (new_upper: INTEGER_32)
effective procedure
{ARRAYED_COLLECTION}
top
mark_item (native_array: NATIVE_ARRAY[E_], index: INTEGER_32)
{}
top
To be used _only_ inside the definition of mark_native_arrays.
Forces the garbage collector to continue the marking process on the index-th element of the native_array. The element at index can be Void or not Void (the Void-ness test performed inside the mark_item itself).