X-Git-Url: http://nitlanguage.org diff --git a/lib/standard/collection/array.nit b/lib/standard/collection/array.nit index a819d54..3cc0b57 100644 --- a/lib/standard/collection/array.nit +++ b/lib/standard/collection/array.nit @@ -13,7 +13,9 @@ # This module introduces the standard array structure. # It also implements two other abstract collections : ArrayMap and ArraySet -module array +module array is + no_warning "useless-type-test" # to avoid warning with nitc while compiling with c_src +end import abstract_collection @@ -21,8 +23,7 @@ import abstract_collection abstract class AbstractArrayRead[E] super SequenceRead[E] - var _length: Int = 0 - redef fun length do return _length + redef var length = 0 redef fun is_empty do return _length == 0 @@ -110,7 +111,7 @@ abstract class AbstractArrayRead[E] # var b = [10, 20, 30, 40, 50] # a.copy_to(1, 2, b, 2) # assert b == [10, 20, 2, 3, 50] - protected fun copy_to(start: Int, len: Int, dest: AbstractArray[E], new_start: Int) + fun copy_to(start: Int, len: Int, dest: AbstractArray[E], new_start: Int) do # TODO native one var i = len @@ -131,7 +132,20 @@ abstract class AbstractArrayRead[E] end end - redef fun iterator: ArrayIterator[E] do return new ArrayIterator[E](self) + redef fun iterator: ArrayIterator[E] do + var res = _free_iterator + if res == null then return new ArrayIterator[E](self) + res._index = 0 + _free_iterator = null + return res + end + + # An old iterator, free to reuse. + # Once an iterator is `finish`, it become reusable. + # Since some arrays are iterated a lot, this avoid most of the + # continuous allocation/garbage-collection of the needed iterators. + private var free_iterator: nullable ArrayIterator[E] = null + redef fun reverse_iterator do return new ArrayReverseIterator[E](self) end @@ -186,6 +200,19 @@ abstract class AbstractArray[E] self[pos] = item end + redef fun insert_all(coll, pos) + do + var l = coll.length + if l == 0 then return + enlarge(length + l) + _length += l + copy_to(pos, length-pos-l, self, pos + l) + for c in coll do + self[pos] = c + pos += 1 + end + end + redef fun add(item) do self[length] = item redef fun clear do _length = 0 @@ -230,6 +257,7 @@ end # Resizable one dimension array of objects. # # Arrays have a literal representation. +# # var a = [12, 32, 8] # # is equivalent with: # var b = new Array[Int] @@ -239,7 +267,7 @@ end # assert a == b class Array[E] super AbstractArray[E] - super ArrayCapable[E] + super Cloneable redef fun [](index) do @@ -269,12 +297,38 @@ class Array[E] _items[l] = item end + # Slight optimization for arrays + redef fun add_all(items) + do + var l = _length + var nl = l + items.length + if _capacity < nl then + enlarge nl + end + + if items isa Array[E] then + var k = 0 + while l < nl do + _items[l] = items._items[k] + l += 1 + k += 1 + end + else + for item in items do + _items[l] = item + l += 1 + end + end + + _length = nl + end + redef fun enlarge(cap) do var c = _capacity if cap <= c then return while c <= cap do c = c * 2 + 2 - var a = calloc_array(c) + var a = new NativeArray[E](c) if _capacity > 0 then _items.copy_to(a, _length) _items = a _capacity = c @@ -305,7 +359,7 @@ class Array[E] init with_capacity(cap: Int) do assert positive: cap >= 0 - _items = calloc_array(cap) + _items = new NativeArray[E](cap) _capacity = cap _length = 0 end @@ -314,7 +368,7 @@ class Array[E] init filled_with(value: E, count: Int) do assert positive: count >= 0 - _items = calloc_array(count) + _items = new NativeArray[E](count) _capacity = count _length = count var i = 0 @@ -334,14 +388,10 @@ class Array[E] end # The internal storage. - var _items: nullable NativeArray[E] = null - - # Do not use this method - # FIXME: Remove it once modules can intrude non local modules - fun intern_items: NativeArray[E] do return _items.as(not null) + private var items: nullable NativeArray[E] = null # The size of `_items`. - var _capacity: Int = 0 + private var capacity: Int = 0 redef fun ==(o) do @@ -358,6 +408,73 @@ class Array[E] end return true end + + # Shallow clone of `self` + # + # ~~~ + # var a = [1,2,3] + # var b = a.clone + # assert a == b + # a.add 4 + # assert a != b + # b.add 4 + # assert a == b + # ~~~ + # + # Note that the clone is shallow and elements are shared between `self` and the result. + # + # ~~~ + # var aa = [a] + # var bb = aa.clone + # assert aa == bb + # aa.first.add 5 + # assert aa == bb + # ~~~ + redef fun clone do return to_a + + # Concatenation of arrays. + # + # Returns a new array built by concatenating `self` and `other` together. + # + # var a1 = [1,2,3] + # var a2 = [4,5,6] + # var a3 = a1 + a2 + # assert a3 == [1,2,3,4,5,6] + # + # Because a new array is always created, future modification on `self` and `other` + # does not impact the previously computed result. + # + # a1.add(30) + # a2.add(60) + # assert a3 == [1,2,3,4,5,6] # unchanged + # assert a1 + a2 == [1,2,3,30,4,5,6,60] + fun +(other: Array[E]): Array[E] + do + var res = new Array[E].with_capacity(length + other.length) + res.append(self) + res.append(other) + return res + end + + # Repetition of arrays. + # + # returns a new array built by concatenating `self` `repeat` times. + # + # var a = [1,2,3] + # assert (a * 0).is_empty + # assert a * 1 == [1,2,3] + # assert a * 2 == [1,2,3,1,2,3] + # assert (a * 10).length == 30 + fun *(repeat: Int): Array[E] + do + assert repeat >= 0 + var res = new Array[E].with_capacity(length * repeat) + while repeat > 0 do + res.add_all(self) + repeat -= 1 + end + return res + end end # An `Iterator` on `AbstractArray` @@ -372,15 +489,11 @@ private class ArrayIterator[E] redef fun next do _index += 1 - init(a: AbstractArrayRead[E]) - do - _array = a - _index = 0 - end + redef var index = 0 - var _index: Int = 0 - redef fun index do return _index - var _array: AbstractArrayRead[E] + var array: AbstractArrayRead[E] + + redef fun finish do _array._free_iterator = self end private class ArrayReverseIterator[E] @@ -390,21 +503,21 @@ private class ArrayReverseIterator[E] redef fun next do _index -= 1 - init(a: AbstractArrayRead[E]) + init do - _array = a - _index = a.length - 1 + _index = _array.length - 1 end end # Others collections ########################################################## # A set implemented with an Array. -class ArraySet[E: Object] +class ArraySet[E] super Set[E] + super Cloneable # The stored elements. - var _array: Array[E] + private var array: Array[E] is noinit redef fun has(e) do return _array.has(e) @@ -448,10 +561,41 @@ class ArraySet[E: Object] init with_capacity(i: Int) do _array = new Array[E].with_capacity(i) redef fun new_set do return new ArraySet[E] + + # Shallow clone of `self` + # + # ~~~ + # var a = new ArraySet[Int] + # a.add 1 + # a.add 2 + # var b = a.clone + # assert a == b + # a.add 3 + # assert a != b + # b.add 3 + # assert a == b + # ~~~ + # + # Note that the clone is shallow and keys and values are shared between `self` and the result. + # + # ~~~ + # var aa = new ArraySet[Array[Int]] + # aa.add([1,2]) + # var bb = aa.clone + # assert aa == bb + # aa.first.add 5 + # assert aa == bb + # ~~~ + redef fun clone + do + var res = new ArraySet[E] + res.add_all self + return res + end end # Iterators on sets implemented with arrays. -private class ArraySetIterator[E: Object] +private class ArraySetIterator[E] super Iterator[E] redef fun is_ok do return _iter.is_ok @@ -460,15 +604,14 @@ private class ArraySetIterator[E: Object] redef fun item: E do return _iter.item - init(iter: ArrayIterator[E]) do _iter = iter - - var _iter: ArrayIterator[E] + var iter: ArrayIterator[E] end # Associative arrays implemented with an array of (key, value) pairs. -class ArrayMap[K: Object, E] +class ArrayMap[K, E] super CoupleMap[K, E] + super Cloneable # O(n) redef fun [](key) @@ -492,8 +635,8 @@ class ArrayMap[K: Object, E] end end - redef var keys: RemovableCollection[K] = new ArrayMapKeys[K, E](self) - redef var values: RemovableCollection[E] = new ArrayMapValues[K, E](self) + redef var keys: RemovableCollection[K] = new ArrayMapKeys[K, E](self) is lazy + redef var values: RemovableCollection[E] = new ArrayMapValues[K, E](self) is lazy # O(1) redef fun length do return _items.length @@ -518,7 +661,7 @@ class ArrayMap[K: Object, E] end # Internal storage. - var _items = new Array[Couple[K,E]] + private var items = new Array[Couple[K,E]] # fast remove the ith element of the array private fun remove_at_index(i: Int) @@ -528,7 +671,7 @@ class ArrayMap[K: Object, E] end # The last positive result given by a index(1) call - var _last_index: Int = 0 + private var last_index: Int = 0 # Where is the `key` in `_item`? # return -1 if not found @@ -547,9 +690,38 @@ class ArrayMap[K: Object, E] end return -1 end + + # Shallow clone of `self` + # + # ~~~ + # var a = new ArrayMap[String,Int] + # a["one"] = 1 + # a["two"] = 2 + # var b = a.clone + # assert a == b + # a["zero"] = 0 + # assert a != b + # ~~~ + # + # Note that the clone is shallow and keys and values are shared between `self` and the result. + # + # ~~~ + # var aa = new ArrayMap[String, Array[Int]] + # aa["two"] = [1,2] + # var bb = aa.clone + # assert aa == bb + # aa["two"].add 5 + # assert aa == bb + # ~~~ + redef fun clone + do + var res = new ArrayMap[K,E] + res.recover_with self + return res + end end -private class ArrayMapKeys[K: Object, E] +private class ArrayMapKeys[K, E] super RemovableCollection[K] # The original map var map: ArrayMap[K, E] @@ -569,7 +741,7 @@ private class ArrayMapKeys[K: Object, E] redef fun remove_all(key) do self.remove(key) end -private class ArrayMapValues[K: Object, E] +private class ArrayMapValues[K, E] super RemovableCollection[E] # The original map var map: ArrayMap[K, E] @@ -722,12 +894,6 @@ end # Native classes ############################################################## -# Subclasses of this class can create native arrays -interface ArrayCapable[E] - # Get a new array of `size` elements. - protected fun calloc_array(size: Int): NativeArray[E] is intern -end - # Native Nit array # Access are unchecked and it has a fixed size # Not for public use: may become private. @@ -738,8 +904,14 @@ universal NativeArray[E] fun length: Int is intern # Use `self` to initialize a standard Nit Array. fun to_a: Array[E] do return new Array[E].with_native(self, length) + + # Get item at `index`. fun [](index: Int): E is intern + + # Set `item` at `index`. fun []=(index: Int, item: E) is intern + + # Copy `length` items to `dest`. fun copy_to(dest: NativeArray[E], length: Int) is intern #fun =(o: NativeArray[E]): Bool is intern #fun !=(o: NativeArray[E]): Bool is intern