HASHED_SET

parent_set

.../base/collection/hashed_set.li line #14

Section:

Inherit

Profile:

+ Self: SELF. parent_set :Expanded  SET( V)

parent_traversable

.../base/collection/low_level/set.li line #15

Section:

Inherit

Profile:

+ Self: SELF. parent_traversable : TRAVERSABLE( V)

parent_safe_equal

.../base/collection/low_level/set.li line #17

Section:

Inherit

Profile:

+ Self: SELF. parent_safe_equal : SAFE_EQUAL( V)

create

.../base/collection/hashed_set.li line #49

Section:

Public

Profile:

- Self: SELF. create : SELF

Description:

Create an empty set. Internal storage capacity of the set is initialized using the Default_size value. Then, tuning of needed storage size is done automatically according to usage. If you are really sure that your set is always really bigger than Default_size, you may use with_capacity to save some execution time.

create_with_capacity

.../base/collection/hashed_set.li line #69

Section:

Public

Profile:

- Self: SELF. create_with_capacity   sz : INTEGER : SELF

Description:

Create an empty set using medium_size as an appropriate value to help initialization of capacity. Thus, this feature may be used in place of make to save some execution time if one is sure that storage size will rapidly become really bigger than Default_size (if not sure, simply use make). Anyway, the initial medium_size value is just an indication and never a limit for the possible capacity. Keep in mind that the capacity tuning is done automatically according to usage.

default_size

.../base/collection/hashed_set.li line #18

Section:

Public

Profile:

- Self: SELF. default_size : INTEGER

Description:

Minimum size for storage in number of items.

buckets

.../base/collection/hashed_set.li line #23

Section:

SET

Profile:

+ Self: SELF. buckets : NATIVE_ARRAY( HASHED_SET_NODE( V))

Description:

The buckets storage area is the primary hash table of capacity elements. To search some element, the first access is done in buckets using the remainder of the division of the key hash_code by capacity. In order to try to avoid clashes, capacity is always a prime number (selected using HASH_TABLE_SIZE).

cache_user

.../base/collection/hashed_set.li line #34

Section:

SET

Profile:

+ Self: SELF. cache_user : INTEGER

Description:

The last user's external index in range [1 .. count] (see item and valid_index for example) may be saved in cache_user otherwise -1 to indicate that the cache is not active. When the cache is active, the corresponding index in buckets is save in cache_buckets and the corresponding node in cache_node.

cache_node

.../base/collection/hashed_set.li line #41

Section:

SET

Profile:

+ Self: SELF. cache_node : HASHED_SET_NODE( V)

Description:

Meaningful only when cache_user is not -1.

cache_buckets

.../base/collection/hashed_set.li line #44

Section:

SET

Profile:

+ Self: SELF. cache_buckets : INTEGER

Description:

Meaningful only when cache_user is not -1.

make

.../base/collection/hashed_set.li line #61

Section:

Public

Profile:

- Self: SELF. make 

Description:

Creation of an empty SET.

with_capacity

.../base/collection/hashed_set.li line #85

Section:

Public

Profile:

- Self: SELF. with_capacity   medium_size : INTEGER

capacity

.../base/collection/hashed_set.li line #106

Section:

Public

Profile:

+ Self: SELF. capacity : INTEGER

Description:

Of the buckets storage area.

count

.../base/collection/hashed_set.li line #108

Section:

Public

Profile:

+ Self: SELF. count : INTEGER

Description:

Cardinality of the set (i.e. actual count of stored elements). Number of available indices.
See also is_empty, lower, upper.

union

.../base/collection/hashed_set.li line #452

Section:

Public

Profile:

- Self: SELF. union   other : SELF

Description:

Make the union of the self set with other. Make the union of the Current set with other.

fast_union

.../base/collection/hashed_set.li line #467

Section:

Public

Profile:

- Self: SELF. fast_union   other : SELF

Description:

Make the union of the self set with other. Make the union of the Current set with other.

is_disjoint

.../base/collection/hashed_set.li line #500

Section:

Public

Profile:

- Self: SELF. is_disjoint   other : SELF : BOOLEAN

fast_is_disjoint

.../base/collection/hashed_set.li line #516

Section:

Public

Profile:

- Self: SELF. fast_is_disjoint   other : SELF : BOOLEAN

minus

.../base/collection/hashed_set.li line #545

Section:

Public

Profile:

- Self: SELF. minus   other : SELF

Description:

Make the set self - other. Make the set Current - other.

is_empty

.../base/collection/low_level/set.li line #31

Section:

Public

Profile:

- Self: SELF. is_empty : BOOLEAN

Description:

Is the set empty? Is collection empty ?
See also count.

add

.../base/collection/hashed_set.li line #114

Section:

Public

Profile:

- Self: SELF. add   e : V

Description:

Add a new item to the set:the mathematical definition of adding in a set is followed. Add new item e to the set. The mathematical definition of adding in a set is followed, i.e. the element e is added only and only if it is not yet present in the set. As this add feature is actually using is_equal, you may consider to use fast_add for expanded objects as well while trying to get the very best performances.

fast_add

.../base/collection/hashed_set.li line #138

Section:

Public

Profile:

- Self: SELF. fast_add   e : V

Description:

Add a new item to the set:the mathematical definition of adding in a set is followed. Same job as add, but uses basic = for comparison.

remove

.../base/collection/hashed_set.li line #162

Section:

Public

Profile:

- Self: SELF. remove   e : V

Description:

Remove item e from the set:the mathematical definition of removing from a set is followed. Remove item e from the set: the mathematical definition of removing from a set is followed.

fast_remove

.../base/collection/hashed_set.li line #192

Section:

Public

Profile:

- Self: SELF. fast_remove   e : V

Description:

Remove item e from the set:the mathematical definition of removing from a set is followed. Same job as remove, but uses basic = for comparison.

clear

.../base/collection/hashed_set.li line #222

Section:

Public

Profile:

- Self: SELF. clear 

Description:

Empty the current set.

clear_count

.../base/collection/low_level/set.li line #102

Section:

Public

Profile:

- Self: SELF. clear_count 

Description:

Empty the current set (is_empty is True after that call). If possible, the actual implementation is supposed to keep its internal storage area in order to refill Current in an efficient way.
See also clear_count_and_capacity to select the most appropriate.

clear_count_and_capacity

.../base/collection/low_level/set.li line #116

Section:

Public

Profile:

- Self: SELF. clear_count_and_capacity 

Description:

Empty the current set (is_empty is True after that call). If possible, the actual implementation is supposed to release its internal storage area for this memory to be used by other objects.
See also clear_count to select the most appropriate.

has

.../base/collection/hashed_set.li line #237

Section:

Public

Profile:

- Self: SELF. has   e : V : BOOLEAN

Description:

Is element e in the set? Is element e in the set? As this query is actually using is_equal, you may consider to use fast_has for expanded objects as well while trying to get the very best performances.

fast_has

.../base/collection/hashed_set.li line #250

Section:

Public

Profile:

- Self: SELF. fast_has   e : V : BOOLEAN

Description:

Is element e in the set? Is element e actually stored in the set? Warning: this query is using basic = for comparison.
See also has when dealing with reference types.

reference_at

.../base/collection/hashed_set.li line #263

Section:

Public

Profile:

- Self: SELF. reference_at   e : V : V

Description:

Non Void when e is in the set. In such a situation, Result is the object which is actually stored in the Current set (see ensure assertion).

reference_at with

.../base/collection/hashed_set.li line #279

Section:

Public

Profile:

- Self: SELF. reference_at   e : V  with   cmp :{( V, V);  BOOLEAN} : V

item

.../base/collection/hashed_set.li line #299

Section:

Public

Profile:

- Self: SELF. item   i : INTEGER : V

Description:

Return the item indexed by index. Item at the corresponding index i.
See also lower, upper, valid_index.
SETs are intrinsically unordered, so there is no guarantee that item(i) after performing an add or remove operation is related in any way to item(i) before that operation. Item at the corresponding index i.
See also lower, upper, valid_index.

lower

.../base/collection/low_level/set.li line #183

Section:

Public

Profile:

- Self: SELF. lower : INTEGER

Description:

Minimum index.
See also upper, valid_index, item.

upper

.../base/collection/low_level/set.li line #185

Section:

Public

Profile:

- Self: SELF. upper : INTEGER

Description:

Maximum index.
See also lower, valid_index, item.

first

.../base/collection/low_level/set.li line #208

Section:

Public

Profile:

- Self: SELF. first : V

Description:

The very first item.
See also last, item.
SETs are intrinsically unordered, so there is no guarantee that first after performing an add or remove operation is related in any way to first before that operation. The very first item.
See also last, item.

last

.../base/collection/low_level/set.li line #217

Section:

Public

Profile:

- Self: SELF. last : V

Description:

The last item.
See also first, item.
SETs are intrinsically unordered, so there is no guarantee that last after performing an add or remove operation is related in any way to last before that operation. The last item.
See also first, item.

intersection

.../base/collection/hashed_set.li line #310

Section:

Public

Profile:

- Self: SELF. intersection   other : SELF

Description:

Make the intersection of the self set with other. Make the intersection of the Current set with other.

copy

.../base/collection/hashed_set.li line #344

Section:

Public

Profile:

- Self: SELF. copy   other : SELF

Description:

Copy 'other' into the current set Copy 'other' into the current set

from_collection

.../base/collection/hashed_set.li line #360

Section:

Public

Profile:

- Self: SELF. from_collection   model : COLLECTION( V)

Description:

Add all items of model.

Infix '+'

.../base/collection/low_level/set.li line #272

Section:

Public

Profile:

- Self: SELF ' + '  other : SELF : SELF

Description:

Return the union of the Current set with other.

fast_intersection

.../base/collection/low_level/set.li line #309

Section:

Public

Profile:

- Self: SELF. fast_intersection   other : SELF

Description:

Make the intersection of the Current set with other.

Infix '^'

.../base/collection/low_level/set.li line #330

Section:

Public

Profile:

- Self: SELF ' ^ '  other : SELF : SELF

Description:

Return the intersection of the Current set with other.

Infix '-'

.../base/collection/low_level/set.li line #367

Section:

Public

Profile:

- Self: SELF ' - '  other : SELF : SELF

Description:

Return the set Current - other.

is_subset_of

.../base/collection/hashed_set.li line #580

Section:

Public

Profile:

- Self: SELF. is_subset_of   other : SELF : BOOLEAN

Description:

Is the self set a subset of other? Is the Current set a subset of other?

is_disjoint_from

.../base/collection/hashed_set.li line #605

Section:

Public

Profile:

- Self: SELF. is_disjoint_from   other : SELF : BOOLEAN

Description:

Is the self set disjoint from other ? Is the Current set disjoint from other ?

Infix '=='

.../base/collection/hashed_set.li line #636

Section:

Public

Profile:

- Self: SELF ' == ' Right 60  other : SELF : BOOLEAN

Description:

Is the self set equal to other? Is the Current set equal to other?

fast_copy

.../base/collection/hashed_set.li line #661

Section:

Public

Profile:

- Self: SELF. fast_copy   other : SELF

Description:

Copy 'other' into the current set

force

.../base/collection/hashed_set.li line #681

Section:

Public

Profile:

- Self: SELF. force   e : V

Description:

Add a new item to the set: the mathematical definition of adding in a set is followed.

search

.../base/collection/hashed_set.li line #699

Section:

Public

Profile:

- Self: SELF. search   e : V : V

Description:

Is element e in the set?

get_if with_hash

.../base/collection/hashed_set.li line #716

Section:

Public

Profile:

- Self: SELF. get_if   cmp : BLOCK  with_hash   h : INTEGER : V

Description:

Is element e in the set?

fast_search

.../base/collection/hashed_set.li line #733

Section:

Public

Profile:

- Self: SELF. fast_search   e : V : V

Description:

Is element e in the set?

fast_index_of

.../base/collection/hashed_set.li line #750

Section:

Public

Profile:

- Self: SELF. fast_index_of   elt : V : INTEGER

fast_is_disjoint_from

.../base/collection/low_level/set.li line #440

Section:

Public

Profile:

- Self: SELF. fast_is_disjoint_from   other : SELF : BOOLEAN

Description:

Is the Current set disjoint from other ?

foreach

.../base/collection/low_level/set.li line #529

Section:

Public

Profile:

- Self: SELF. foreach   action :{ V; }

do_all

.../base/collection/low_level/set.li line #531

Section:

Public

Profile:

- Self: SELF. do_all   action :{ V; }

Description:

Apply action to every item of Self.
See also for_all, exists.

for_all

.../base/collection/low_level/set.li line #544

Section:

Public

Profile:

- Self: SELF. for_all   predicate : BLOCK : BOOLEAN

Description:

Do all items satisfy predicate?
See also do_all, exists.

exists

.../base/collection/low_level/set.li line #560

Section:

Public

Profile:

- Self: SELF. exists   predicate : BLOCK : BOOLEAN

Description:

Does at least one item satisfy predicate?
See also do_all, for_all.