chore: fix invariants and prefer using append! over append!

Author: SuperFola

List.ark

@@ -487,6 +487,7 @@
   [_list1 _list2] }))
 
 # @brief Zip two lists into one: [1 2 3 4] and [5 6 7 8] will give [[1 5] [2 6] [3 7] [4 8]]
+# @details Lists must have the same size. Otherwise, only the first (min (len _a) (len _b)) elements will be used.
 # @param _a the first list to work on
 # @param _b the second list to work on
 # @details The original lists are not modified.
@@ -523,9 +524,15 @@
   (mut _index 0)
 
   (while (< _index _m) {
-    (append! _c [
-      (if (< _index (len _a)) (@ _a _index) _filler)
-      (if (< _index (len _b)) (@ _b _index) _filler)])
+    (append!
+      _c
+      [
+        (if (< _index (len _a))
+          (@ _a _index)
+          _filler)
+        (if (< _index (len _b))
+          (@ _b _index)
+          _filler)])
     (set _index (+ 1 _index)) })
   _c }))
 
@@ -743,7 +750,7 @@
   _early }))
 
 # @brief Transpose a list of lists or list of strings
-# @details The original list is not modified. Each element should have the same length
+# @details The original list is not modified. Elements should have the same length
 # @param _L list of lists/strings to transpose
 # =begin
 # (let data [[1 2 3] [4 5 6] [7 8 9])
@@ -800,8 +807,7 @@
   (mut _i 0)
   (while (< _i (len _indices)) {
     (let _idx (@ _indices _i))
-    (if (< _idx (len _L))
-      (append! _output (@ _L _idx)))
+    (if (< _idx (len _L)) (append! _output (@ _L _idx)))
     (set _i (+ 1 _i)) })
   _output }))
 
@@ -831,9 +837,11 @@
           (while _continue {
             (mut _i nil)
             (if
-              (forEach _reversed_indices (fun (_val) {
-                (set _i _val)
-                (if (!= (@ _indices _i) (+ _i _len (* -1 _r))) stopIteration) }))
+(forEach
+                _reversed_indices
+                (fun (_val) {
+                  (set _i _val)
+                  (if (!= (@ _indices _i) (+ _i _len (* -1 _r))) stopIteration) }))
               {
                 (@= _indices _i (+ 1 (@ _indices _i)))
                 (mut _j (+ 1 _i))
@@ -872,9 +880,11 @@
           (while _continue {
             (mut _i nil)
             (if
-              (forEach _reversed_range (fun (_val) {
-                (set _i _val)
-                (if (!= (@ _indices _i) (- _len 1)) stopIteration) }))
+(forEach
+                _reversed_range
+                (fun (_val) {
+                  (set _i _val)
+                  (if (!= (@ _indices _i) (- _len 1)) stopIteration) }))
               {
                 (mut _j _i)
                 (let _val (+ 1 (@ _indices _i)))

Macros.ark

@@ -71,7 +71,6 @@
         (__replace_placeholders (tail replacements) ...xs) }
       {
         x
-
         (__replace_placeholders replacements ...xs) })) })
 
 # @brief Create a partial function with prefilled arguments, allowing some arguments to be skipped

Math.ark

@@ -237,7 +237,7 @@
     0
     (exp (* 0.5 (ln _x))))))
 
-# @brief Run the fibonacci function on a number
+# @brief Compute the nth fibonacci term
 # @param n the number
 # @author https://github.com/SuperFola
 (let fibo (fun (n) {
@@ -275,14 +275,13 @@
 # =end
 # @author https://github.com/Wafelack
 (let divs (fun (n) {
-  (assert (>= n 2) "divs: n must be greater or equal to 2")
-  (mut i 2)
-  (mut divisors [1])
+  (assert (>= n 1) "divs: n must be greater or equal to 1")
+  (mut i 1)
+  (mut divisors [])
   (let top (ceil (/ n 2)))
 
   (while (and (<= i top) (!= top n)) {
-    (if (= (mod n i) 0)
-      (set divisors (append divisors i)))
+    (if (= (mod n i) 0) (append! divisors i))
     (set i (+ i 1)) })
   (append divisors n) }))
 
@@ -294,8 +293,7 @@
 # =end
 # @author https://github.com/Gryfenfer97
 (let log (fun (x n) {
-  (assert (> x 0) "log: x must be greater than 0")
-  (assert (>= n 1) "log: n must be greater or equal to 1")
+  (assert (and (> x 0) (>= n 1)) "log: x must be greater than 0, and n must be greater or equal to 1")
   (round (/ (ln x) (ln n))) }))
 
 # @brief Returns the logarithm base 2 of a number
@@ -444,7 +442,7 @@
 # (let base 55)  # something takes 55ms to run
 # (let new 43)  # now it takes 43ms
 # (print (math:improvementRatioPercentage base new))  # 27.9069767442
-# # 'base' is 27%~ slower than 'new'
+# # 'new' is 27%~ faster than 'base'
 # =end
 # @author https://github.com/SuperFola
 (let improvementRatioPercentage (fun (_a _b) (* 100 (- (/ _a _b) 1))))
@@ -467,17 +465,15 @@
 # (print (math:radians 90))   # pi/2
 # =end
 # @author https://github.com/SuperFola
-(let radians (fun (_degrees)
-  (/ (* _degrees pi) 180)))
+(let radians (fun (_degrees) (/ (* _degrees pi) 180)))
 
 # @brief Convert an angle in radians to degrees
 # @param _radians angle in radians
 # =begin
 # (print (math:radians (/ math:pi 2)))   # 90
 # =end
 # @author https://github.com/SuperFola
-(let degrees (fun (_radians)
-  (/ (* 180 _radians) pi)))
+(let degrees (fun (_radians) (/ (* 180 _radians) pi)))
 
 # @brief Check if a given number is an integer
 # @param _x number
@@ -486,8 +482,7 @@
 # (print (math:integer 1.000001))   # false
 # =end
 # @author https://github.com/SuperFola
-(let integer? (fun (_x)
-  (= (ceil _x) (floor _x))))
+(let integer? (fun (_x) (= (ceil _x) (floor _x))))
 
 # @brief Compute the factorial of a number
 # @param _n integer
@@ -512,11 +507,7 @@
 # @author https://github.com/SuperFola
 (let binomialCoeff (fun (_n _k)
   (if (<= _k _n)
-    (/
-      (factorial _n)
-      (*
-        (factorial _k)
-        (factorial (- _n _k))))
+    (/ (factorial _n) (* (factorial _k) (factorial (- _n _k))))
     0)))
 
 # @brief Compute the number of ways to choose k items from n items without repetition and with order
@@ -526,9 +517,7 @@
 # @author https://github.com/SuperFola
 (let permutations (fun (_n _k)
   (if (<= _k _n)
-    (/
-      (factorial _n)
-      (factorial (- _n _k)))
+    (/ (factorial _n) (factorial (- _n _k)))
     0)))
 
 # @brief Compare two real numbers and return true if the first one is near the second one (1e-7 precision)
@@ -537,7 +526,7 @@
 # @author https://github.com/SuperFola
 (let close? (fun (_n _target) {
   # todo: make epsilon configurable
-  (let _epsilon 1e-7)
+  (let _epsilon 1e-07)
   (and (< (- _target _epsilon) _n) (< _n (+ _target _epsilon))) }))
 
 # @brief Compute the euclidean distance between two vectors of the same size
@@ -579,7 +568,4 @@
 # (print (math:lcm 4 6))  # 12
 # =end
 # @author https://github.com/SuperFola
-(let lcm (fun (_a _b)
-  (*
-    (abs _a)
-    (/ (abs _b) (gcd _a _b)))))
+(let lcm (fun (_a _b) (* (abs _a) (/ (abs _b) (gcd _a _b)))))

Range.ark

@@ -66,8 +66,7 @@
   (mut _output [])
 
   (while (not (nil? _value)) {
-    (if (_fun _value)
-      (set _output (append _output _value)))
+    (if (_fun _value) (append! _output _value))
     (set _value (_range)) })
   (_range.reset)
   _output }))
@@ -86,7 +85,7 @@
   (mut _output [])
 
   (while (not (nil? _value)) {
-    (set _output (append _output (_fun _value)))
+    (append! _output (_fun _value))
     (set _value (_range)) })
   (_range.reset)
   _output }))

String.ark

@@ -440,8 +440,7 @@
 # (print (string:startsWith? "Hello, world" ", world"))  # false
 # =end
 # @author https://github.com/SuperFola
-(let startsWith? (fun (_str _prefix)
-  (= 0 (find _str _prefix))))
+(let startsWith? (fun (_str _prefix) (= 0 (find _str _prefix))))
 
 # @brief Check if a string ends with a given suffix
 # @param _str string
@@ -451,8 +450,9 @@
 # (print (string:endsWith? "Hello, world" "worl"))  # false
 # =end
 # @author https://github.com/SuperFola
-(let endsWith? (fun (_str _suffix)
-  (= 0 (find (reverse _str) (reverse _suffix)))))
+(let endsWith? (fun (_str _suffix) {
+  (let _end (- (len _str) (len _suffix)))
+  (= _end (findAfter _str _suffix _end)) }))
 
 # @brief Return a string filled with '0' digits to make a string of length _n
 # @param _str string to left fill
@@ -478,12 +478,15 @@
     _str
     {
       (let _fill (- _len (len _str)))
-      (let _fill_left (if (= 1 (mod _fill 2)) (/ (- _fill 1) 2) (/ _fill 2)))
-      (let _fill_right (if (= 1 (mod _fill 2)) (/ (+ _fill 1) 2) (/ _fill 2)))
-      (+
-        (repeat " " _fill_left)
-        _str
-        (repeat " " _fill_right)) })))
+      (let _fill_left
+        (if (= 1 (mod _fill 2))
+          (/ (- _fill 1) 2)
+          (/ _fill 2)))
+      (let _fill_right
+        (if (= 1 (mod _fill 2))
+          (/ (+ _fill 1) 2)
+          (/ _fill 2)))
+      (+ (repeat " " _fill_left) _str (repeat " " _fill_right)) })))
 
 # @brief If a string starts with a given prefix, remove it
 # @param _str string