+
Point of view
ANY
class ORDERED_DICTIONARY [V_, K_ -> HASHABLE]
Summary
Class invariant
Overview
creation features
  • make
    Create an empty dictionary.
  • with_capacity (medium_size: INTEGER_32)
    May be used to save some execution time if one is sure that storage size will rapidly become really bigger than Default_size.
exported features
  • fast_put (v: V_, k: K_)
    Same job as put, but uses basic = for comparison.
  • remove (k: K_)
    Remove entry k (which may exist or not before this call).
  • fast_remove (k: K_)
    Same job as remove, but uses basic = for comparison.
  • item (index: INTEGER_32): V_
    Item at the corresponding index i.
  • key (index: INTEGER_32): K_
  • key_map_in (buffer: COLLECTION[K_])
    Append in buffer, all available keys (this may be useful to speed up the traversal).
  • item_map_in (buffer: COLLECTION[V_])
    Append in buffer, all available items (this may be useful to speed up the traversal).
  • internal_key (k: K_): K_
    Retrieve the internal key object which correspond to the existing entry k (the one memorized into the Current dictionary).
Counting:
Basic access:
  • infix "@" (k: K_): V_
    The infix notation which is actually a synonym for at.
Looking and searching some value:
To provide iterating facilities:
  • is_equal (other: ORDERED_DICTIONARY [V_, K_ -> HASHABLE]): BOOLEAN
    Do both dictionaries have the same set of associations?
  • is_equal_map (other: ORDERED_DICTIONARY [V_, K_ -> HASHABLE]): BOOLEAN
    Do both dictionaries have the same set of associations?
Agents based features:
Indexing:
Other features:
put (v: V_, k: K_)
effective procedure
Change some existing entry or add the new one.
copy (other: ORDERED_DICTIONARY [V_, K_ -> HASHABLE])
effective procedure
Reinitialize by copying all associations of other.
clear_count
effective procedure
Discard all items (is_empty is True after that call).
clear_count_and_capacity
effective procedure
Discard all items (is_empty is True after that call).
add (v: V_, k: K_)
effective procedure
To add a new entry k with its associated value v.
get_new_iterator_on_keys: ITERATOR[K_]
effective function
Default_size: INTEGER_32
constant attribute
Default size for the storage area in number of items.
capacity: INTEGER_32
writable attribute
Of the buckets storage area.
count: INTEGER_32
writable attribute
Number of available indices.
has (k: K_): BOOLEAN
effective function
Is there a value currently associated with key k?
at (k: K_): V_
effective function
Return the value associated to key k.
reference_at (k: K_): V_
effective function
Return Void or the value associated with key k.
fast_has (k: K_): BOOLEAN
effective function
Is there a value currently associated with key k?
fast_at (k: K_): V_
effective function
Return the value associated to key k using basic = for comparison.
fast_reference_at (k: K_): V_
effective function
Same work as reference_at, but basic = is used for comparison.
fast_put (v: V_, k: K_)
effective procedure
Same job as put, but uses basic = for comparison.
remove (k: K_)
effective procedure
Remove entry k (which may exist or not before this call).
fast_remove (k: K_)
effective procedure
Same job as remove, but uses basic = for comparison.
item (index: INTEGER_32): V_
effective function
Item at the corresponding index i.
key (index: INTEGER_32): K_
effective function
key_map_in (buffer: COLLECTION[K_])
effective procedure
Append in buffer, all available keys (this may be useful to speed up the traversal).
item_map_in (buffer: COLLECTION[V_])
effective procedure
Append in buffer, all available items (this may be useful to speed up the traversal).
internal_key (k: K_): K_
effective function
Retrieve the internal key object which correspond to the existing entry k (the one memorized into the Current dictionary).
is_empty: BOOLEAN
effective function
Is it empty?
infix "@" (k: K_): V_
frozen
effective function
The infix notation which is actually a synonym for at.
occurrences (v: V_): INTEGER_32
effective function
Number of occurrences using is_equal for comparison.
fast_occurrences (v: V_): INTEGER_32
effective function
Number of occurrences using basic = for comparison.
key_at (v: V_): K_
effective function
Retrieve the key used for value v using is_equal for comparison.
fast_key_at (v: V_): K_
effective function
Retrieve the key used for value v using = for comparison.
lower: INTEGER_32
constant attribute
Minimum index.
upper: INTEGER_32
effective function
Maximum index.
first: V_
effective function
The very first item.
last: V_
effective function
The last item.
get_new_iterator_on_items: ITERATOR[V_]
effective function
is_equal (other: ORDERED_DICTIONARY [V_, K_ -> HASHABLE]): BOOLEAN
effective function
Do both dictionaries have the same set of associations?
is_equal_map (other: ORDERED_DICTIONARY [V_, K_ -> HASHABLE]): BOOLEAN
effective function
Do both dictionaries have the same set of associations?
do_all (action: ROUTINE[TUPLE[TUPLE 2[V_, K_]]])
effective procedure
Apply action to every [V_, K_] associations of Current.
for_all (test: FUNCTION[TUPLE[TUPLE 2[V_, K_]]]): BOOLEAN
effective function
Do all [V_, K_] associations satisfy test?
exists (test: FUNCTION[TUPLE[TUPLE 2[V_, K_]]]): BOOLEAN
effective function
Does at least one [V_, K_] association satisfy test?
valid_index (i: INTEGER_32): BOOLEAN
effective function
True when i is valid (i.e., inside actual bounds).
get_new_iterator: ITERATOR[E_]
deferred function