+
Point of view
All features
deferred class BIJECTIVE_DICTIONARY [V_, K_]
Summary
top
Bijective associative memory. As for ordinary DICTIONARY, Values of type V_ are stored using Keys of type K_, but, in a BIJECTIVE_DICTIONARY, given one value of type V_, you can retrieve the unique corresponding key of type K_. In other words, with a BIJECTIVE_DICTIONARY, one key of type K_ gives you access to one value of type V_ which can be used to retrieve back the same unique original key.
At time being, the only one available implementation is the HASHED_BIJECTIVE_DICTIONARY class.
See also DICTIONARY class if you do not have a unique value for each key. By the way, also note that the interface of DICTIONARY is similar to the interface of BIJECTIVE_DICTIONARY in order to allow you to move from one to the other.
Direct parents
Inherit list: MAP
Known children
Inherit list: BIJECTIVE_DICTIONARY_REVERSER, HASHED_BIJECTIVE_DICTIONARY
Overview
top
Features
Basic access:
{ANY}
Looking and searching some value:
{ANY}
{ANY}
  • put (v: V_, k: K_) assign at
    Change some existing entry or add the new one.
  • add (v: V_, k: K_)
    To add a new entry k with its associated value v.
Removing:
{ANY}
To provide iterating facilities:
{ANY}
Other features:
{ANY}
  • internal_key (k: K_): K_
    Retrieve the internal key object which correspond to the existing entry k (the one memorized into the Current dictionary).
{}
Implement manifest generic creation:
{}
Counting:
{ANY}
Basic access:
{ANY}
  • has (k: K_): BOOLEAN
    Is there a value currently associated with key k?
  • at (k: K_): V_
    Return the value associated to key k.
  • infix "@" (k: K_): V_
    The infix notation which is actually a synonym for at.
  • reference_at (k: K_): V_
    Return Void or the value associated with key k.
  • fast_has (k: K_): BOOLEAN
    Is there a value currently associated with key k?
  • fast_at (k: K_): V_
    Return the value associated to key k using basic = for comparison.
  • fast_reference_at (k: K_): V_
    Same work as reference_at, but basic = is used for comparison.
Looking and searching some value:
{ANY}
  • key_at (v: V_): K_
    Retrieve the key used for value v using is_equal for comparison.
  • fast_key_at (v: V_): K_
    Retrieve the key used for value v using = for comparison.
To provide iterating facilities:
{ANY}
  • lower: INTEGER_32
    Minimum index.
  • upper: INTEGER_32
    Maximum index.
  • item (index: INTEGER_32): V_
    Item at the corresponding index i.
  • key (index: INTEGER_32): K_
  • first: V_
    The very first item.
  • last: V_
    The last item.
  • 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).
  • keys: TRAVERSABLE[K_]
    An iterable of this map keys
  • items: TRAVERSABLE[V_]
    An iterable of this map values Usually returns Current because MAP is TRAVERSABLE.
{ANY}
  • fast_is_equal (other: BIJECTIVE_DICTIONARY [V_, K_]): BOOLEAN
    Do both dictionaries have the same set of associations?
  • is_equal (other: BIJECTIVE_DICTIONARY [V_, K_]): BOOLEAN
    Do both dictionaries have the same set of associations?
  • is_equal_map (other: BIJECTIVE_DICTIONARY [V_, K_]): BOOLEAN
    Do both collections have the same lower, upper, and items?
Display support:
{ANY}
Agents based features:
{ANY}
{}
{}
{ANY}
Other features:
{ANY}
{ANY}
{}
Counting:
{ANY}
{}
Indexing:
{ANY}
has_value (v: V_): BOOLEAN
deferred function
{ANY}
top
Is there a value v?
require
  • v /= Void
ensure
fast_has_value (v: V_): BOOLEAN
deferred function
{ANY}
top
Is there a value v?
require
  • v /= Void
ensure
occurrences (v: V_): INTEGER_32
effective function
{ANY}
top
Number of occurrences using is_equal for comparison.
See also fast_occurrences, fast_has, has.
ensure
  • Result.in_range(0, 1)
  • Result >= 0
fast_occurrences (v: V_): INTEGER_32
effective function
{ANY}
top
Number of occurrences using basic = for comparison.
See also occurrences, fast_has, has.
ensure
  • Result.in_range(0, 1)
  • Result >= 0
put (v: V_, k: K_) assign at
deferred procedure
{ANY}
top
Change some existing entry or add the new one.
If there as yet no key k in the dictionary, enter it with item v. Otherwise overwrite the item associated with key k.
require ensure
add (v: V_, k: K_)
deferred procedure
{ANY}
top
To add a new entry k with its associated value v.
Actually, this is equivalent to call put, but may run a little bit faster.
require ensure
remove (k: K_)
deferred procedure
{ANY}
top
Remove entry k (which may exist or not before this call).
require
  • k /= Void
ensure
clear_count
deferred procedure
{ANY}
top
Discard all items (is_empty is True after that call).
The internal capacity is not changed by this call. See also clear_count_and_capacity to select the most appropriate.
ensure
clear_count_and_capacity
deferred procedure
{ANY}
top
Discard all items (is_empty is True after that call).
The internal capacity may also be reduced after this call. See also clear_count to select the most appropriate.
ensure
capacity: INTEGER_32
deferred function
{ANY}
top
Approximation of the actual internal storage capacity.
The capacity will grow automatically when needed (i.e. capacity is not a limit for the number of values stored). Also note that the capacity value may not be always accurate depending of the implementation (anyway, this capacity value is at least equals to count).
new_iterator_on_items: ITERATOR[V_]
effective function
{ANY}
top
ensure
  • Result /= Void
  • Result /= Void
  • Result.generation = generation
new_iterator_on_keys: ITERATOR[K_]
effective function
{ANY}
top
ensure
  • Result /= Void
new_iterator: ITERATOR[TUPLE 2[V_, K_]]
effective function
{ANY}
top
ensure
  • Result /= Void
internal_key (k: K_): K_
deferred function
{ANY}
top
Retrieve the internal key object which correspond to the existing entry k (the one memorized into the Current dictionary).
require
  • has(k)
ensure
key_safe_equal (k1: K_, k2: K_): BOOLEAN
frozen
effective function
{}
top
Because keys are never Void, we do not rely on the SAFE_EQUAL class.
require
  • k1 /= Void
  • k2 /= Void
val_safe_equal (v1: V_, v2: V_): BOOLEAN
frozen
effective function
{}
top
Because values are never Void, we do not rely on the SAFE_EQUAL class.
require
  • v1 /= Void
  • v2 /= Void
manifest_put (index: INTEGER_32, v: V_, k: K_)
effective procedure
{}
top
require
  • v /= Void
  • k /= Void
  • not has(k)
manifest_semicolon_check: INTEGER_32
is 2
constant attribute
{}
top
Put semicolons between successive value-key pairs.
is_empty: BOOLEAN
effective function
{ANY}
top
Is it empty?
ensure
  • definition: Result = count = 0
has (k: K_): BOOLEAN
deferred function
{ANY}
top
Is there a value currently associated with key k?
See also fast_has, at.
require
  • k /= Void
at (k: K_): V_
deferred function
{ANY}
top
Return the value associated to key k.
See also fast_at, reference_at, has.
require
infix "@" (k: K_): V_
frozen
effective function
{ANY}
top
The infix notation which is actually a synonym for at.
require ensure
  • definition: Result = at(k)
reference_at (k: K_): V_
deferred function
{ANY}
top
Return Void or the value associated with key k.
Actually, this feature is useful only when the type of values (the type V_) is a reference type, to avoid using has just followed by at to get the corresponding value with the very best performances.
See also fast_reference_at, at, has.
require
  • k /= Void
  • values_are_not_expanded: Result = Void
ensure
  • has(k) implies Result = at(k)
fast_has (k: K_): BOOLEAN
deferred function
{ANY}
top
Is there a value currently associated with key k?
Using basic = for comparison.
See also has, at, fast_at.
require
  • k /= Void
fast_at (k: K_): V_
deferred function
{ANY}
top
Return the value associated to key k using basic = for comparison.
See also at, reference_at, fast_reference_at.
require
fast_reference_at (k: K_): V_
deferred function
{ANY}
top
Same work as reference_at, but basic = is used for comparison.
See also reference_at, at, has.
require
  • k /= Void
  • values_are_reference: Result = Void
ensure
key_at (v: V_): K_
effective function
{ANY}
top
Retrieve the key used for value v using is_equal for comparison.
See also fast_key_at, at.
require ensure
fast_key_at (v: V_): K_
effective function
{ANY}
top
Retrieve the key used for value v using = for comparison.
See also key_at, at.
require ensure
  • at(Result) = v
lower: INTEGER_32
is 1
constant attribute
{ANY}
top
Minimum index.
See also upper, valid_index, item.
upper: INTEGER_32
effective function
{ANY}
top
Maximum index.
See also lower, valid_index, item.
ensure
item (index: INTEGER_32): V_
deferred function
{ANY}
top
Item at the corresponding index i.
See also lower, upper, valid_index.
require
  • valid_index(index)
ensure
key (index: INTEGER_32): K_
deferred function
{ANY}
top
require ensure
first: V_
effective function
{ANY}
top
The very first item.
See also last, item.
require
  • not is_empty
ensure
  • definition: Result = item(lower)
last: V_
effective function
{ANY}
top
The last item.
See also first, item.
require
  • not is_empty
ensure
  • definition: Result = item(upper)
key_map_in (buffer: COLLECTION[K_])
effective procedure
{ANY}
top
Append in buffer, all available keys (this may be useful to speed up the traversal).
See also item_map_in.
require
  • buffer /= Void
ensure
  • buffer.count = count + old buffer.count
item_map_in (buffer: COLLECTION[V_])
effective procedure
{ANY}
top
Append in buffer, all available items (this may be useful to speed up the traversal).
See also key_map_in.
require
  • buffer /= Void
ensure
  • buffer.count = count + old buffer.count
keys: TRAVERSABLE[K_]
effective function
{ANY}
top
An iterable of this map keys
ensure
items: TRAVERSABLE[V_]
effective function
{ANY}
top
An iterable of this map values Usually returns Current because MAP is TRAVERSABLE.
ensure
fast_is_equal (other: BIJECTIVE_DICTIONARY [V_, K_]): BOOLEAN
effective function
{ANY}
top
Do both dictionaries have the same set of associations?
Keys are compared with is_equal and values are compared with the basic = operator.
See also is_equal.
ensure
is_equal (other: BIJECTIVE_DICTIONARY [V_, K_]): BOOLEAN
effective function
{ANY}
top
Do both dictionaries have the same set of associations?
Both keys and values are compared with is_equal.
See also fast_is_equal.
require
    • other /= Void
    • other /= Void
ensure
  • commutative: generating_type = other.generating_type implies Result = other.is_equal(Current)
is_equal_map (other: BIJECTIVE_DICTIONARY [V_, K_]): BOOLEAN
effective function
{ANY}
top
Do both collections have the same lower, upper, and items?
This feature is obsolete: Use `is_equal' instead.
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
    • 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))
for_each (action: PROCEDURE[TUPLE[TUPLE 2[V_, K_]]])
effective procedure
{ANY}
top
Apply action to every [V_, K_] associations of Current.
See also for_all, exist.
require
  • action /= Void
do_all (action: ROUTINE[TUPLE[TUPLE 2[V_, K_]]])
frozen
effective procedure
{ANY}
top
Apply action to every [V_, K_] associations of Current.
This feature is obsolete: This feature is not secure because it accepts a FUNCTION, the result of which is lost. Plese use `for_each` instead.
for_all (test: FUNCTION[TUPLE[TUPLE 2[V_, K_]]]): BOOLEAN
effective function
{ANY}
top
Do all [V_, K_] associations satisfy test?
See also for_each, exist.
require
  • test /= Void
exists (test: FUNCTION[TUPLE[TUPLE 2[V_, K_]]]): BOOLEAN
effective function
{ANY}
top
Does at least one [V_, K_] association satisfy test?
See also for_all, for_each.
require
  • test /= Void
aggregate (action: FUNCTION[TUPLE[TUPLE 3[V_, V_, K_], V_]], initial: V_): V_
effective function
{ANY}
top
Aggregate all the elements starting from the initial value.
See also for_each, for_all, exists.
require
  • action /= Void
keys_memory: DICTIONARY_KEY_TRAVERSER[V_, K_]
writable attribute
{}
top
_inline_agent43 (v: V_, k: K_)
frozen
effective procedure
{}
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.
generation: INTEGER_32
writable attribute
{ANY}
top
next_generation
effective procedure
{}
top
ensure
count: INTEGER_32
deferred function
{ANY}
top
Number of available items in the hoard.
See also is_empty
ensure
  • Result >= 0
_inline_agent1 (a: ROUTINE[TUPLE[TUPLE 1[E_]]], e: E_)
frozen
effective procedure
{}
top
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