X-Git-Url: http://nitlanguage.org

diff --git a/lib/standard/collection/array.nit b/lib/standard/collection/array.nit
index 23fcf5f..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
-package array
+module array is
+	no_warning "useless-type-test" # to avoid warning with nitc while compiling with c_src
+end
 
 import abstract_collection
 
@@ -21,7 +23,7 @@ import abstract_collection
 abstract class AbstractArrayRead[E]
 	super SequenceRead[E]
 
-	redef readable var _length: Int = 0
+	redef var length = 0
 
 	redef fun is_empty do return _length == 0
 
@@ -61,13 +63,9 @@ abstract class AbstractArrayRead[E]
 
 	redef fun index_of(item) do return index_of_from(item, 0)
 
-	# The index of the last occurrence of an element.
-	# Return -1 if not found.
-	fun last_index_of(item: E): Int do return last_index_of_from(item, length-1)
+	redef fun last_index_of(item: E): Int do return last_index_of_from(item, length-1)
 
-	# The index of the first occurrence of an element starting from pos.
-	# Return -1 if not found.
-	fun index_of_from(item: E, pos: Int): Int
+	redef fun index_of_from(item: E, pos: Int): Int
 	do
 		var i = pos
 		var len = length
@@ -80,9 +78,7 @@ abstract class AbstractArrayRead[E]
 		return -1
 	end
 
-	# The index of the last occurrence of an element starting from pos.
-	# Return -1 if not found.
-	fun last_index_of_from(item: E, pos: Int): Int
+	redef fun last_index_of_from(item: E, pos: Int): Int
 	do
 		var i = pos
 		while i >= 0 do
@@ -115,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
@@ -136,21 +132,21 @@ abstract class AbstractArrayRead[E]
 		end
 	end
 
-	redef fun iterator: ArrayIterator[E] do return new ArrayIterator[E](self)
-
-	# Two arrays are equals if they have the same items in the same order.
-	redef fun ==(o)
-	do
-		if not o isa AbstractArray[nullable Object] or o is null then return false
-		var l = length
-		if o.length != l then return false
-		var i = 0
-		while i < l do
-			if self[i] != o[i] then return false
-			i += 1
-		end
-		return true
+	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
 
 # Resizable one dimension array of objects.
@@ -190,25 +186,33 @@ abstract class AbstractArray[E]
 	redef fun unshift(item)
 	do
 		var i = length - 1
-		while i > 0 do
+		while i >= 0 do
 			self[i+1] = self[i]
 			i -= 1
 		end
 		self[0] = item
 	end
 
-	# Insert an element at a given position, following elements are shifted.
-	#
-	#     var a= [10, 20, 30, 40]
-	#     a.insert(100, 2)
-	#     assert a      ==  [10, 20, 100, 30, 40]
-	fun insert(item: E, pos: Int)
+	redef fun insert(item: E, pos: Int)
 	do
 		enlarge(length + 1)
 		copy_to(pos, length-pos, self, pos + 1)
 		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
@@ -245,7 +249,7 @@ abstract class AbstractArray[E]
 	fun swap_at(a: Int,b: Int)
 	do
 	    var e = self[a]
-	    self[a] = b
+	    self[a] = self[b]
 	    self[b] = e
 	end
 end
@@ -253,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]
@@ -262,19 +267,7 @@ end
 #     assert a == b
 class Array[E]
 	super AbstractArray[E]
-	super ArrayCapable[E]
-
-	redef fun iterate
-		!each(e: E)
-	do
-		var i = 0
-		var l = _length
-		var items = _items
-		while i < length do
-			each(items[i])
-			i += 1
-		end
-	end
+	super Cloneable
 
 	redef fun [](index)
 	do
@@ -304,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
@@ -340,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
@@ -349,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
@@ -369,70 +388,97 @@ 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
-
-	# Sort the array using the !cmp function.
-	fun sort
-		!cmp(e1,e2: E): Int
-	do
-		sub_sort(0, length-1) !cmp(x,y) = cmp(x, y)
-	end
-
-	# Sort `array` between `from` and `to` indices
-	private fun sub_sort(from: Int, to: Int)
-		!cmp(e1,e2: E): Int
-	do
-		if from >= to then
-			return
-		else if from + 7 < to then
-			var pivot = self[from]
-			var i = from
-			var j = to
-			while j > i do
-				while i <= to and cmp(self[i], pivot) <= 0 do i += 1
-				while j > i and cmp(self[j], pivot) >= 0 do j -= 1
-				if j > i then
-					var t = self[i]
-					self[i] = self[j]
-					self[j] = t
-				end
-			end
-			self[from] = self[i-1]
-			self[i-1] = pivot
-			sub_sort(from, i-2) !cmp(x,y) = cmp(x, y)
-			sub_sort(i, to) !cmp(x,y) = cmp(x, y)
-		else
-			var i = from
-			while i < to do
-				var min = i
-				var min_v = self[i]
-				var j = i
-				while j <= to do
-					if cmp(min_v, self[j]) > 0 then
-						min = j
-						min_v = self[j]
-					end
-					j += 1
-				end
-				if min != i then
-					self[min] = self[i]
-					self[i] = min_v
-				end
-				i += 1
-			end
+	private var capacity: Int = 0
+
+	redef fun ==(o)
+	do
+		if not o isa Array[nullable Object] then return super
+		# Efficient implementation
+		var l = length
+		if l != o.length then return false
+		var i = 0
+		var it = _items
+		var oit = o._items
+		while i < l do
+			if it[i] != oit[i] then return false
+			i += 1
+		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`
-class ArrayIterator[E]
+private class ArrayIterator[E]
 	super IndexedIterator[E]
 
 	redef fun item do return _array[_index]
@@ -443,24 +489,35 @@ class ArrayIterator[E]
 
 	redef fun next do _index += 1
 
-	init(a: AbstractArrayRead[E])
+	redef var index = 0
+
+	var array: AbstractArrayRead[E]
+
+	redef fun finish do _array._free_iterator = self
+end
+
+private class ArrayReverseIterator[E]
+	super ArrayIterator[E]
+
+	redef fun is_ok do return _index >= 0
+
+	redef fun next do _index -= 1
+
+	init
 	do
-		_array = a
-		_index = 0
+		_index = _array.length - 1
 	end
-
-	redef readable var _index: Int = 0
-	var _array: AbstractArrayRead[E]
 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)
 
@@ -502,10 +559,43 @@ class ArraySet[E: Object]
 
 	# Create an empty set with a given capacity.
 	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.
-class ArraySetIterator[E: Object]
+private class ArraySetIterator[E]
 	super Iterator[E]
 
 	redef fun is_ok do return _iter.is_ok
@@ -514,15 +604,14 @@ 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)
@@ -531,7 +620,7 @@ class ArrayMap[K: Object, E]
 		if i >= 0 then
 			return _items[i].second
 		else
-			abort
+			return provide_default_value(key)
 		end
 	end
 
@@ -546,13 +635,13 @@ class ArrayMap[K: Object, E]
 		end
 	end
 
-	redef var keys: ArrayMapKeys[K, E] = new ArrayMapKeys[K, E](self)
-	redef var values: ArrayMapValues[K, 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
 
-	redef fun iterator: CoupleMapIterator[K, E] do return new CoupleMapIterator[K, E](_items.iterator)
+	redef fun couple_iterator do return _items.iterator
 
 	redef fun is_empty do return _items.is_empty
 
@@ -572,7 +661,7 @@ class ArrayMap[K: Object, E]
 	end
 
 	# Internal storage.
-	var _items: 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)
@@ -582,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
@@ -602,14 +691,37 @@ class ArrayMap[K: Object, E]
 		return -1
 	end
 
-	# A new empty map.
-	init
-	do
-		_items = new Array[Couple[K,E]]
+	# 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
 
-class ArrayMapKeys[K: Object, E]
+private class ArrayMapKeys[K, E]
 	super RemovableCollection[K]
 	# The original map
 	var map: ArrayMap[K, E]
@@ -629,7 +741,7 @@ class ArrayMapKeys[K: Object, E]
 	redef fun remove_all(key) do self.remove(key)
 end
 
-class ArrayMapValues[K: Object, E]
+private class ArrayMapValues[K, E]
 	super RemovableCollection[E]
 	# The original map
 	var map: ArrayMap[K, E]
@@ -688,6 +800,72 @@ class ArrayMapValues[K: Object, E]
 	end
 end
 
+# Comparable array for comparable elements.
+#
+# For two arrays, if one is a prefix, then it is lower.
+#
+# ~~~
+# var a12 = new ArrayCmp[nullable Int].with_items(1,2)
+# var a123 = new ArrayCmp[nullable Int].with_items(1,2,3)
+# assert a12 < a123
+# ~~~
+#
+# Otherwise, the first element just after the longest
+# common prefix gives the order between the two arrays.
+#
+# ~~~
+# var a124 = new ArrayCmp[nullable Int].with_items(1,2,4)
+# var a13 = new ArrayCmp[nullable Int].with_items(1,3)
+# assert a12  < a123
+# assert a123 < a13
+# ~~~
+#
+# Obviously, two equal arrays are equal.
+#
+# ~~~
+# var b12 = new ArrayCmp[nullable Int].with_items(1,2)
+# assert (a12 <=> b12) == 0
+# ~~~
+#
+# `null` is considered lower than any other elements.
+# But is still greater than no element.
+#
+# ~~~
+# var a12n = new ArrayCmp[nullable Int].with_items(1,2,null)
+# assert a12n < a123
+# assert a12  < a12n
+# ~~~
+class ArrayCmp[E: nullable Comparable]
+	super Array[E]
+	super Comparable
+	redef type OTHER: ArrayCmp[E] is fixed
+
+	redef fun <(o) do return (self <=> o) < 0
+
+	redef fun <=>(o)
+	do
+		var it = _items
+		var oit = o._items
+		var i = 0
+		var l = length
+		var ol = o.length
+		var len
+		if l < ol then len = l else len = ol
+		while i < len do
+			var a = it[i]
+			var b = oit[i]
+			if a != null then
+				if b == null then return 1
+				var d = a <=> b.as(Comparable)
+				if d != 0 then return d
+			else
+				if b != null then return -1
+			end
+			i += 1
+		end
+		return l <=> ol
+	end
+end
 
 # Others tools ################################################################
 
@@ -708,22 +886,32 @@ redef class Collection[E]
 	# Build a new array from a collection
 	fun to_a: Array[E]
 	do
-		return iterator.to_a
+		var res = new Array[E].with_capacity(length)
+		res.add_all(self)
+		return res
 	end
 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 C array (void ...).
+# Native Nit array
+# Access are unchecked and it has a fixed size
+# Not for public use: may become private.
 universal NativeArray[E]
+	# Creates a new NativeArray of capacity `length`
+	new(length: Int) is intern
+	# The length of the array
+	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