Extend array stdlib (#839)

dvdvgt · web-flow · commit 2b937176c572 · 2025-03-04T17:16:01.000+01:00
closes #804 This PR aims to extend the stdlib of `array`. Most of the added functions are in-place compared to their counterparts for `list`. Feel free to bike-shed. I am looking forward to your feedback. ## TODO - [x] Add complete test suit for all functions - [x] There is `indexOf`, `lastIndexOf` and `find`, probably not all of them are needed. - [x] It would be nice if someone could check the implementation `c_array_fill` as I am not too familiar with LLVM and the memory management. - [x] ~~Decide on naming convention: ruby- vs scala-style (e.g. `map!` vs `mapped`)?~~ Change everything to Ruby style - [x] Measure performance of the extern definition of `fill` compared to a definition in effekt
diff --git a/examples/stdlib/array/all.check b/examples/stdlib/array/all.check
@@ -0,0 +1,5 @@
+true
+true
+false
+false
+true
diff --git a/examples/stdlib/array/all.effekt b/examples/stdlib/array/all.effekt
@@ -0,0 +1,12 @@
+def main() = {
+  val arr1 = array(10, 42)
+  println(arr1.all { x => x == 42 })
+
+  val empty = array(0, 42)
+  println(empty.all { x => x == 42 })
+
+  val arr2 = array::build(10) { x => x + 1 }
+  println(arr2.all { x => x < 10 })
+  println(arr2.all { x => x < 0 })
+  println(arr2.all { x => x < 11 } == not(arr2.any { x => x >= 11 }))
+}
diff --git a/examples/stdlib/array/any.check b/examples/stdlib/array/any.check
@@ -0,0 +1,5 @@
+true
+false
+true
+true
+true
diff --git a/examples/stdlib/array/any.effekt b/examples/stdlib/array/any.effekt
@@ -0,0 +1,13 @@
+def main() = {
+  val arr1 = array(10, 42)
+  println(arr1.any { x => x == 42 })
+
+  val empty = array(0, 42)
+  println(empty.any { x => x == 42 })
+
+  val arr2 = array::build(10) { x => x + 1 }
+  println(arr2.any { x => x >= 10 })
+  println(arr2.any { x => x <= 1 })
+  println(not(arr2.all { x => x < 11 }) == arr2.any { x => x >= 11 })
+
+}
diff --git a/examples/stdlib/array/binarySearch.check b/examples/stdlib/array/binarySearch.check
@@ -0,0 +1,5 @@
+not found
+not found
+found at 0
+found at 499
+found at 100
diff --git a/examples/stdlib/array/binarySearch.effekt b/examples/stdlib/array/binarySearch.effekt
@@ -0,0 +1,17 @@
+import stringbuffer
+
+def find(arr: Array[Int], elem: Int): Unit = {
+  val optIdx = arr.binarySearch(elem) { compareInt }
+  optIdx match {
+    case None() => println("not found")
+    case Some(idx) => println(s"found at ${idx.show}")
+  }
+}
+
+def main() = {
+  find(fromList([]), 1)
+  find(fromList([0]), 1)
+  find(fromList([0]), 0)
+  find(array(1000, 1), 1)
+  find(array::build(1000) { x => x }, 100)
+}
diff --git a/examples/stdlib/array/count.check b/examples/stdlib/array/count.check
@@ -0,0 +1,4 @@
+10
+0
+0
+10
diff --git a/examples/stdlib/array/count.effekt b/examples/stdlib/array/count.effekt
@@ -0,0 +1,6 @@
+def main() = {
+  println(array(10, 1).count { x => x == 1 }) 
+  println(array(10, 1).count { x => x != 1 }) 
+  println(array(0, 1).count { x => x == 1 })
+  println(array::build(20) { x => x + 1}.count { x => mod(x, 2) == 0 })
+}
diff --git a/examples/stdlib/array/drop.check b/examples/stdlib/array/drop.check
@@ -0,0 +1,4 @@
+Array()
+Array()
+true
+true
diff --git a/examples/stdlib/array/drop.effekt b/examples/stdlib/array/drop.effekt
@@ -0,0 +1,6 @@
+def main() = {
+  println(array(0, "a").drop(1))
+  println(array(1, "a").drop(1))
+  println(array(10, 1).drop(5).size == 5)
+  println(array(10, 1).drop(0).size == 10)
+}
diff --git a/examples/stdlib/array/equals.check b/examples/stdlib/array/equals.check
@@ -0,0 +1,6 @@
+false
+true
+true
+false
+false
+true
diff --git a/examples/stdlib/array/equals.effekt b/examples/stdlib/array/equals.effekt
@@ -0,0 +1,8 @@
+def main() = {
+  println(equals(array(0, 1), array(1, 1)) { (x, y) => x == y })
+  println(equals(array(100, 1), array(100, 1)) { (x, y) => x == y })
+  println(equals(array(0, 1), array(0, 1)) { (x, y) => x == y })
+  println(equals([1, 2, 3].fromList, [1, 2, 2].fromList) { (x, y) => x == y })
+  println(equals([1, 2, 3].fromList, [2, 2, 3].fromList) { (x, y) => x == y })
+  println(equals(array(0, 1), array(0, 1)) { (x, y) => x == y })
+}
diff --git a/examples/stdlib/array/filtered.check b/examples/stdlib/array/filtered.check
@@ -0,0 +1,5 @@
+Array(0, 1, 2, 3, 4)
+Array()
+Array(1, 1, 1, 1, 1)
+Array()
+true
diff --git a/examples/stdlib/array/filtered.effekt b/examples/stdlib/array/filtered.effekt
@@ -0,0 +1,7 @@
+def main() = {
+  println(array::build(10) { x => x }.filtered { x => x < 5 })
+  println(array(0, 1).filtered { x => x > 0 })
+  println(array(5, 1).filtered { x => x == 1 })
+  println(array(5, 1).filtered { x => x != 1 })
+  println(array::build(10000) { x => x + 1 }.filtered { x => mod(x, 2) == 0 }.size == 5000)
+}
diff --git a/examples/stdlib/array/foldLeft.check b/examples/stdlib/array/foldLeft.check
@@ -0,0 +1,4 @@
+45
+49995000
+0
+helloworld,effekt!
diff --git a/examples/stdlib/array/foldLeft.effekt b/examples/stdlib/array/foldLeft.effekt
@@ -0,0 +1,6 @@
+def main() = {
+  println(array::build(10) { x => x }.foldLeft(0) { (acc, x) => acc + x })
+  println(array::build(10000) { x => x }.foldLeft(0) { (acc, x) => acc + x })
+  println(array::allocate[Int](0).foldLeft(0) { (acc, x) => acc + x })
+  println(["hello", "world", ",", "effekt!"].fromList.foldLeft("") { (acc, x) => acc ++ x })
+}
diff --git a/examples/stdlib/array/foldRight.check b/examples/stdlib/array/foldRight.check
@@ -0,0 +1,4 @@
+45
+49995000
+0
+helloworld,effekt!
diff --git a/examples/stdlib/array/foldRight.effekt b/examples/stdlib/array/foldRight.effekt
@@ -0,0 +1,6 @@
+def main() = {
+  println(array::build(10) { x => x }.foldRight(0) { (acc, x) => acc + x })
+  println(array::build(10000) { x => x }.foldRight(0) { (acc, x) => acc + x })
+  println(array::allocate[Int](0).foldRight(0) { (acc, x) => acc + x })
+  println(["hello", "world", ",", "effekt!"].fromList.foldRight("") { (acc, x) => acc ++ x })
+}
diff --git a/examples/stdlib/array/indexOf.check b/examples/stdlib/array/indexOf.check
@@ -0,0 +1,4 @@
+None()
+Some(0)
+Some(0)
+Some(9)
diff --git a/examples/stdlib/array/indexOf.effekt b/examples/stdlib/array/indexOf.effekt
@@ -0,0 +1,6 @@
+def main() = {
+  println(array(0, 1).indexOf(1) { (x, y) => x == y })
+  println(array(1, 1).indexOf(1) { (x, y) => x == y })
+  println(array(10, 1).indexOf(1) { (x, y) => x == y })
+  println(array::build(10) { x => x }.indexOf(9) { (x, y) => x == y })
+}
diff --git a/examples/stdlib/array/lastIndexOf.check b/examples/stdlib/array/lastIndexOf.check
@@ -0,0 +1,4 @@
+None()
+Some(0)
+Some(9)
+Some(9)
diff --git a/examples/stdlib/array/lastIndexOf.effekt b/examples/stdlib/array/lastIndexOf.effekt
@@ -0,0 +1,6 @@
+def main() = {
+  println(array(0, 1).lastIndexOf(1) { (x, y) => x == y })
+  println(array(1, 1).lastIndexOf(1) { (x, y) => x == y })
+  println(array(10, 1).lastIndexOf(1) { (x, y) => x == y })
+  println(array::build(10) { x => x }.lastIndexOf(9) { (x, y) => x == y })
+}
diff --git a/examples/stdlib/array/map.check b/examples/stdlib/array/map.check
@@ -0,0 +1,2 @@
+Array(84, 84, 84, 84, 84)
+Array()
diff --git a/examples/stdlib/array/map.effekt b/examples/stdlib/array/map.effekt
@@ -0,0 +1,9 @@
+def main() = {
+  val arr = array(5, 42)
+  arr.map { x => x * 2 }
+  println(arr)
+
+  val arr1 = allocate(0)
+  arr1.map { x => x * 2 }
+  println(arr1)
+}
diff --git a/examples/stdlib/array/mapped.check b/examples/stdlib/array/mapped.check
@@ -0,0 +1,3 @@
+true
+Array()
+Array(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
diff --git a/examples/stdlib/array/mapped.effekt b/examples/stdlib/array/mapped.effekt
@@ -0,0 +1,6 @@
+def main() = {
+  val arr1 = array::build(10) { x => x }
+  println(equals(arr1, arr1.mapped { x => x * 2 }.mapped { x => x / 2 }) { (x, y) => x == y })
+  println(array(0, 1).mapped { x => x + 1 })
+  println(arr1.mapped { x => x.show })
+}
diff --git a/examples/stdlib/array/partioned.check b/examples/stdlib/array/partioned.check
@@ -0,0 +1,10 @@
+Array(0, 1, 2, 3, 4)
+Array(5, 6, 7, 8, 9)
+Array(4, 3, 2, 1, 0)
+Array(9, 8, 7, 6, 5)
+Array()
+Array(0, 1, 2, 3, 4)
+true
+true
+true
+true
diff --git a/examples/stdlib/array/partioned.effekt b/examples/stdlib/array/partioned.effekt
@@ -0,0 +1,21 @@
+def main() = {
+  val (arr1, arr2) = array::build(10) { x => x }.partioned { x => x < 5 }
+  println(arr1)
+  println(arr2)
+
+  val (arr3, arr4) = array::build(10) { x => x }.reversed.partioned { x => x < 5 }
+  println(arr3)
+  println(arr4)
+
+  val (arr5, arr6) = array::build(5) { x => x }.partioned { x => x > 4 }
+  println(arr5)
+  println(arr6)
+
+  val (arr7, arr8) = array::build(5) { x => x }.partioned { x => x <= 4 }
+  println(arr8.equals(arr5) { (x, y) => x == y })
+  println(arr7.equals(arr6) { (x, y) => x == y })
+
+  val (arr9, arr10) = array(0, 1).partioned { x => x > 0 }
+  println(arr9.size == 0)
+  println(arr10.size == 0)  
+}
diff --git a/examples/stdlib/array/reverse.check b/examples/stdlib/array/reverse.check
@@ -0,0 +1,3 @@
+Array()
+Array(4, 3, 2, 1, 0)
+Array(0, 1, 2, 3, 4)
diff --git a/examples/stdlib/array/reverse.effekt b/examples/stdlib/array/reverse.effekt
@@ -0,0 +1,11 @@
+def main() = {
+  val empty = array(0, 1)
+  empty.reverse
+  println(empty)
+
+  val arr1 = array::build(5) { x => x }
+  arr1.reverse
+  println(arr1)
+  arr1.reverse
+  println(arr1)
+}
diff --git a/examples/stdlib/array/reversed.check b/examples/stdlib/array/reversed.check
@@ -0,0 +1,7 @@
+Array()
+Array()
+Array(c, b, a)
+true
+Array(b, a)
+true
+true
diff --git a/examples/stdlib/array/reversed.effekt b/examples/stdlib/array/reversed.effekt
@@ -0,0 +1,15 @@
+def main() = {
+  println(array(0, 1).reversed)
+  println(array(0, 1).reversed.reversed)
+
+  val arr1 = ["a", "b", "c"].fromList
+  println(arr1.reversed)
+  println(equals(arr1, arr1.reversed.reversed) { (x, y) => x == y })
+
+  val arr2 = ["a", "b"].fromList
+  println(arr2.reversed)
+  println(equals(arr2, arr2.reversed.reversed) { (x, y) => x == y })
+
+  val arr3 = array::build(1000) { x => x }
+  println(equals(arr3, arr3.reversed.reversed) { (x, y) => x == y })
+}
diff --git a/examples/stdlib/array/sliced.check b/examples/stdlib/array/sliced.check
@@ -0,0 +1,4 @@
+Array()
+Array(1, 1)
+Array()
+true
diff --git a/examples/stdlib/array/sliced.effekt b/examples/stdlib/array/sliced.effekt
@@ -0,0 +1,6 @@
+def main() = {
+  println(array(0, 1).sliced(0, 2))
+  println(array(2, 1).sliced(0, 2))
+  println(array(10, 1).sliced(2, 1))
+  println(array(10, 1).sliced(0, 5).size == 5)
+}
diff --git a/examples/stdlib/array/sort.check b/examples/stdlib/array/sort.check
@@ -0,0 +1,6 @@
+Array()
+Array(5)
+Array(-1, 1, 3, 5)
+Array(-2, -1, 0, 1, 2, 3)
+Array(-2, -1, 0, 1, 2, 3)
+Array(-1, -1, -1)
diff --git a/examples/stdlib/array/sort.effekt b/examples/stdlib/array/sort.effekt
@@ -0,0 +1,14 @@
+def sort(l: List[Int]): Unit = {
+  val arr = l.array::fromList
+  arr.sort { compareInt }
+  println(arr)
+}
+
+def main() = {
+  sort([])
+  sort([5])
+  sort([1, 3, -1, 5])
+  sort([-2, -1, 0, 1, 2, 3])
+  sort([3, 2, 1, 0, -1, -2])
+  sort([-1, -1, -1])
+}
diff --git a/examples/stdlib/array/take.check b/examples/stdlib/array/take.check
@@ -0,0 +1,3 @@
+Array()
+Array(1)
+true
diff --git a/examples/stdlib/array/take.effekt b/examples/stdlib/array/take.effekt
@@ -0,0 +1,5 @@
+def main() = {
+  println(array(0, 1).take(1))
+  println(array(1, 1).take(2))
+  println(array(10, "a").take(5).size == 5)
+}
diff --git a/examples/stdlib/array/unzipped.check b/examples/stdlib/array/unzipped.check
@@ -0,0 +1,8 @@
+true
+true
+true
+true
+true
+true
+true
+true
diff --git a/examples/stdlib/array/unzipped.effekt b/examples/stdlib/array/unzipped.effekt
@@ -0,0 +1,16 @@
+def main() = {
+  val (arr1, arr2) = array(0, "a").zipped(array(0, "a")).unzipped
+  println(arr1.size == 0)
+  println(arr2.size == 0)
+  val (arr3, arr4) = array(0, 1).zipped(array(1, 1)).unzipped
+  println(arr3.size == 0)
+  println(arr4.size == 0)
+  val (arr5, arr6) = array(1, 1).zipped(array(0, 1)).unzipped
+  println(arr5.size == 0)
+  println(arr6.size == 0)
+  val arr7 = array(10, "a")
+  val arr8 = array(10, 1)
+  val (arr9, arr10) = arr7.zipped(arr8).unzipped
+  println(equals(arr7, arr9) { (x, y) => x == y })
+  println(equals(arr8, arr10) { (x, y) => x == y })
+}
diff --git a/examples/stdlib/array/zipped.check b/examples/stdlib/array/zipped.check
@@ -0,0 +1,4 @@
+true
+true
+true
+true
diff --git a/examples/stdlib/array/zipped.effekt b/examples/stdlib/array/zipped.effekt
@@ -0,0 +1,7 @@
+def main() = {
+  println(array(0, "a").zipped(array(0, "a")).size == 0)
+  println(array(0, 1).zipped(array(1, 1)).size == 0)
+  println(array(1, 1).zipped(array(0, 1)).size == 0)
+  val arr1 = array::build(10) { x => x }
+  println(arr1.zipped(arr1.mapped { x => x.show }).size == 10)
+}
diff --git a/examples/stdlib/array/zippedWith.check b/examples/stdlib/array/zippedWith.check
@@ -0,0 +1,4 @@
+true
+true
+true
+Array(12, 14, 16, 18, 20, 22, 24, 26, 28, 30)
diff --git a/examples/stdlib/array/zippedWith.effekt b/examples/stdlib/array/zippedWith.effekt
@@ -0,0 +1,8 @@
+def main() = {
+  println(array(0, "a").zippedWith(array(0, "a")) { (x, y) => x ++ y }.size == 0)
+  println(array(0, 1).zippedWith(array(1, 1)) { (x, y) => x + y }.size == 0)
+  println(array(1, 1).zippedWith(array(0, 1)) { (x, y) => x + y }.size == 0)
+  val arr1 = array::build(10) { x => x + 1 }
+  val arr2 = array::build(10) { x => x + 11 }
+  println(arr1.zippedWith(arr2) { (x, y) => x + y })
+}
diff --git a/libraries/common/array.effekt b/libraries/common/array.effekt
diff --git a/libraries/llvm/file.c b/libraries/llvm/file.c

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +true
 +true
 +false
 +false
 +true