1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2004-2008 Jean Privat <jean@pryen.org>
5 # This file is free software, which comes along with NIT. This software is
6 # distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
7 # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
8 # PARTICULAR PURPOSE. You can modify it is you want, provided this header
9 # is kept unaltered, and a notification of the changes is added.
10 # You are allowed to redistribute it and sell it, alone or is a part of
13 # This module define several abstract collection classes.
14 module abstract_collection
18 # The root of the collection hierarchy.
20 # Collections modelize finite groups of objects, called elements.
22 # The specific behavior and representation of collections is determined
23 # by the subclasses of the hierarchy.
25 # The main service of Collection is to provide a stable `iterator`
26 # method usable to retrieve all the elements of the collection.
28 # Additional services are provided.
29 # For an implementation point of view, Collection provide a basic
30 # implementation of these services using the `iterator` method.
31 # Subclasses often provide a more efficient implementation.
33 # Because of the `iterator` method, Collections instances can use
34 # the `for` control structure:
36 # var x: Collection[U]
43 # that is equivalent with
45 # var x: Collection[U]
49 # var u = i.item # u is a U
53 interface Collection[E
]
54 # Get a new iterator on the collection.
55 fun iterator
: Iterator[E
] is abstract
57 # Is there no item in the collection?
59 # assert [1,2,3].is_empty == false
60 # assert [1..1[.is_empty == true
61 fun is_empty
: Bool do return length
== 0
63 # Number of items in the collection.
65 # assert [10,20,30].length == 3
66 # assert [20..30[.length == 10
70 for i
in self do nb
+= 1
75 # Is `item` in the collection ?
76 # Comparisons are done with ==
78 # assert [1,2,3].has(2) == true
79 # assert [1,2,3].has(9) == false
80 # assert [1..5[.has(2) == true
81 # assert [1..5[.has(9) == false
82 fun has
(item
: E
): Bool
84 for i
in self do if i
== item
then return true
88 # Is the collection contain only `item`?
89 # Comparisons are done with ==
90 # Return true if the collection is empty.
92 # assert [1,1,1].has_only(1) == true
93 # assert [1,2,3].has_only(1) == false
94 # assert [1..1].has_only(1) == true
95 # assert [1..3].has_only(1) == false
96 # assert [3..3[.has_only(1) == true # empty collection
98 # ENSURE `is_empty implies result == true`
99 fun has_only
(item
: E
): Bool
101 for i
in self do if i
!= item
then return false
105 # How many occurrences of `item` are in the collection?
106 # Comparisons are done with ==
108 # assert [10,20,10].count(10) == 2
109 fun count
(item
: E
): Int
112 for i
in self do if i
== item
then nb
+= 1
116 # Return one the item of the collection
118 # assert [1,2,3].first == 1
125 # Is the collection contains all the elements of `other`?
127 # assert [1,1,1].has_all([1]) == true
128 # assert [1,1,1].has_all([1,2]) == false
129 # assert [1,3,4,2].has_all([1..2]) == true
130 # assert [1,3,4,2].has_all([1..5]) == false
131 fun has_all
(other
: Collection[E
]): Bool
133 for x
in other
do if not has
(x
) then return false
138 # Instances of the Iterator class generates a series of elements, one at a time.
139 # They are mainly used with collections.
140 interface Iterator[E
]
143 fun item
: E
is abstract
145 # Jump to the next item.
149 # Is there a current item ?
150 fun is_ok
: Bool is abstract
153 # A collection that contains only one item.
157 redef fun first
do return _item
159 redef fun is_empty
do return false
161 redef fun length
do return 1
163 redef fun has
(an_item
) do return _item
== an_item
165 redef fun has_only
(an_item
) do return _item
== an_item
167 redef fun count
(an_item
)
169 if _item
== an_item
then
176 redef fun iterator
do return new ContainerIterator[E
](self)
178 # Create a new instance with a given initial value.
179 init(e
: E
) do _item
= e
182 readable writable var _item
: E
185 # This iterator is quite stupid since it is used for only one item.
186 class ContainerIterator[E
]
188 redef fun item
do return _container
.item
190 redef fun next
do _is_ok
= false
192 init(c
: Container[E
]) do _container
= c
194 redef readable var _is_ok
: Bool = true
196 var _container
: Container[E
]
199 # Items can be removed from this collection
200 interface RemovableCollection[E
]
203 fun clear
is abstract
205 # Remove an occucence of `item`
206 fun remove
(item
: E
) is abstract
208 # Remove all occurences of `item`
209 fun remove_all
(item
: E
) do while has
(item
) do remove
(item
)
212 # Items can be added to these collections.
213 interface SimpleCollection[E
]
214 super RemovableCollection[E
]
215 # Add an item in a collection.
216 # Ensure col.has(item)
217 fun add
(item
: E
) is abstract
219 # Add each item of `coll`.
220 fun add_all
(coll
: Collection[E
]) do for i
in coll
do add
(i
)
225 # Set contains contains only one element with the same value (according to ==).
226 # var s: Set[String] = new ArraySet[String]
228 # var b = "Hel" + "lo"
231 # assert s.has(b) == true
232 interface Set[E
: Object]
233 super SimpleCollection[E
]
235 redef fun has_only
(item
)
248 redef fun count
(item
)
257 # Synonym of remove since there is only one item
258 redef fun remove_all
(item
) do remove
(item
)
260 # Equality is defined on set and means that each set contains the same elements
263 if not other
isa Set[Object] then return false
264 if other
.length
!= length
then return false
265 return has_all
(other
)
268 # because of the law between `==` and `hash`, hash is redefined to be the sum of the hash of the elements
272 for e
in self do res
+= res
.hash
277 # MapRead are abstract associative collections: `key` -> `item`.
278 interface MapRead[K
: Object, E
]
279 # Get the item at `key`.
280 fun [](key
: K
): E
is abstract
282 # Get the item at `key` or return `default` if not in map
283 fun get_or_default
(key
: K
, default
: E
): E
285 if has_key
(key
) then return self[key
]
289 # Depreciated alias for `keys.has`
290 fun has_key
(key
: K
): Bool do return self.keys
.has
(key
)
292 # Get a new iterator on the map.
293 fun iterator
: MapIterator[K
, E
] is abstract
295 # Return the point of view of self on the values only.
296 # Note that `self` and `values` are views on the same data;
297 # therefore any modification of one is visible on the other.
298 fun values
: Collection[E
] is abstract
300 # Return the point of view of self on the keys only.
301 # Note that `self` and `keys` are views on the same data;
302 # therefore any modification of one is visible on the other.
303 fun keys
: Collection[K
] is abstract
305 # Is there no item in the collection?
306 fun is_empty
: Bool is abstract
308 # Number of items in the collection.
309 fun length
: Int is abstract
312 # Maps are associative collections: `key` -> `item`.
314 # The main operator over maps is [].
316 # var map: Map[String, Int] = new ArrayMap[String, Int]
318 # map["one"] = 1 # Associate 'one' to '1'
319 # map["two"] = 2 # Associate 'two' to '2'
320 # assert map["one"] == 1
321 # assert map["two"] == 2
323 # Instances of maps can be used with the for structure
325 # for key, value in map do
326 # assert (key == "one" and value == 1) or (key == "two" and value == 2)
329 # The keys and values in the map can also be manipulated directly with the `keys` and `values` methods.
331 # assert map.keys.has("one") == true
332 # assert map.keys.has("tree") == false
333 # assert map.values.has(1) == true
334 # assert map.values.has(3) == false
336 interface Map[K
: Object, E
]
338 # Set the`item` at `key`.
339 fun []=(key
: K
, item
: E
) is abstract
341 # Add each (key,value) of `map` into `self`.
342 # If a same key exists in `map` and `self`, then the value in self is discarded.
343 fun recover_with
(map
: Map[K
, E
])
353 fun clear
is abstract
355 redef fun values
: RemovableCollection[E
] is abstract
357 redef fun keys
: RemovableCollection[K
] is abstract
361 interface MapIterator[K
: Object, E
]
364 fun item
: E
is abstract
366 # The key of the current item.
368 fun key
: K
is abstract
370 # Jump to the next item.
374 # Is there a current item ?
375 fun is_ok
: Bool is abstract
377 # Set a new `item` at `key`.
378 #fun item=(item: E) is abstract
381 # Iterator on a 'keys' point of view of a map
382 class MapKeysIterator[K
: Object, V
]
384 # The original iterator
385 var iterator
: MapIterator[K
, V
]
387 redef fun is_ok
do return self.iterator
.is_ok
388 redef fun next
do self.iterator
.next
389 redef fun item
do return self.iterator
.key
392 # Iterator on a 'values' point of view of a map
393 class MapValuesIterator[K
: Object, V
]
395 # The original iterator
396 var iterator
: MapIterator[K
, V
]
398 redef fun is_ok
do return self.iterator
.is_ok
399 redef fun next
do self.iterator
.next
400 redef fun item
do return self.iterator
.item
403 # Sequences are indexed collections.
404 # The first item is 0. The last is `length-1`.
405 interface SequenceRead[E
]
407 # Get the first item.
408 # Is equivalent with `self[0]`.
411 assert not_empty
: not is_empty
415 # Return the index=th element of the sequence.
416 # The first element is 0 and the last if `length-1`
417 # If index is invalid, the program aborts
418 fun [](index
: Int): E
is abstract
421 # Is equivalent with `self[length-1]`.
424 assert not_empty
: not is_empty
425 return self[length-1
]
428 # Return the index of the first occurrence of `item`.
429 # Return -1 if `item` is not found
430 # Comparison is done with ==
431 fun index_of
(item
: E
): Int
435 if i
.item
== item
then return i
.index
441 redef fun iterator
: IndexedIterator[E
] is abstract
443 # Two sequences are equals if they have the same items in the same order.
446 if not o
isa SequenceRead[nullable Object] then return false
448 if o
.length
!= l
then return false
451 if self[i
] != o
[i
] then return false
457 # because of the law between `==` and `hash`, hash is redefined to be the sum of the hash of the elements
461 for e
in self do res
+= res
.hash
466 # Sequence are indexed collection.
467 # The first item is 0. The last is `length-1`.
468 interface Sequence[E
]
469 super SequenceRead[E
]
470 super SimpleCollection[E
]
472 # Set the first item.
473 # Is equivalent with `self[0] = item`.
475 do self[0] = item
end
478 # Is equivalent with `self[length-1] = item`.
489 # A synonym of `push`
490 redef fun add
(e
) do push
(e
)
492 # Add an item after the last.
493 fun push
(e
: E
) is abstract
495 # Add each item of `coll` after the last.
496 fun append
(coll
: Collection[E
]) do for i
in coll
do push
(i
)
498 # Remove the last item.
499 fun pop
: E
is abstract
501 # Add an item before the last.
502 fun unshift
(e
: E
) is abstract
504 # Remove the first item.
505 # The second item become the first.
506 fun shift
: E
is abstract
508 # Set the `item` at `index`.
509 fun []=(index
: Int, item
: E
) is abstract
511 # Remove the item at `index` and shift all following elements
512 fun remove_at
(index
: Int) is abstract
515 # Iterators on indexed collections.
516 interface IndexedIterator[E
]
518 # The index of the current item.
519 fun index
: Int is abstract
522 # Associative arrays that internally uses couples to represent each (key, value) pairs.
523 interface CoupleMap[K
: Object, E
]
525 # Return the couple of the corresponding key
526 # Return null if the key is no associated element
527 protected fun couple_at
(key
: K
): nullable Couple[K
, E
] is abstract
531 var c
= couple_at
(key
)
540 # Iterator on CoupleMap
542 # Actually is is a wrapper around an iterator of the internal array of the map.
543 class CoupleMapIterator[K
: Object, E
]
544 super MapIterator[K
, E
]
545 redef fun item
do return _iter
.item
.second
547 #redef fun item=(e) do _iter.item.second = e
549 redef fun key
do return _iter
.item
.first
551 redef fun is_ok
do return _iter
.is_ok
558 var _iter
: Iterator[Couple[K
,E
]]
560 init(i
: Iterator[Couple[K
,E
]]) do _iter
= i
563 # Some tools ###################################################################
565 # Two objects in a simple structure.
568 # The first element of the couple.
569 readable writable var _first
: F
571 # The second element of the couple.
572 readable writable var _second
: S
574 # Create a new instance with a first and a second object.