@grain/stdlib 0.4.4 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,92 @@
 # Changelog
 
+## [0.5.0](https://github.com/grain-lang/grain/compare/stdlib-v0.4.6...stdlib-v0.5.0) (2022-06-05)
+
+
+### ⚠ BREAKING CHANGES
+
+* **stdlib:** Use explicit exports for Pervasives (#1301)
+* **stdlib:** Remove `sum` function from the List module (#1300)
+* **stdlib:** Ensure Void return for forEach functions in List module (#1307)
+* **stdlib:** Provide correct types for BigInt operations (#1297)
+* **grainfmt:** Replace `--in-place` flag with `-o` flag
+* **grainfmt:** Remove stdin formatting support
+* **compiler:** Arbitrary-Precision Integer Arithmetic (#1167)
+* Drop node 14 support (#1092)
+* **stdlib:** Add explicit void return type on Set.forEach (#1225)
+* **stdlib:** Add explicit void return type on Map.forEach (#1220)
+* **stdlib:** Add type aliases to regex lib (#1036)
+* **compiler:** Stack-allocated Chars (#1103)
+* **stdlib:** Align Buffer's `addStringSlice` API with String's `slice` (#1136)
+* **graindoc:** Add `--current-version` flag, required for since/history attributes (#1116)
+* **compiler:** Remove decRefIgnoreZeros (#1068)
+* **compiler:** Add `--memory-base` flag (#1115)
+* **compiler:** Re-implement Grain parser (#1033)
+
+### Features
+
+* **compiler:** Add `--memory-base` flag ([#1115](https://github.com/grain-lang/grain/issues/1115)) ([0680826](https://github.com/grain-lang/grain/commit/068082663c4387c3ab54c052869e9b9a06b87e26))
+* **compiler:** Arbitrary-Precision Integer Arithmetic ([#1167](https://github.com/grain-lang/grain/issues/1167)) ([6f34de2](https://github.com/grain-lang/grain/commit/6f34de214b28358ea1df553685fa3a19336ddba9))
+* **compiler:** Call known functions across module boundaries ([#1175](https://github.com/grain-lang/grain/issues/1175)) ([b2d7440](https://github.com/grain-lang/grain/commit/b2d744034ec7e0601554531c910e9d0f5451d464))
+* **compiler:** Convert `runtime/dataStructures.gr` to primitives ([#1145](https://github.com/grain-lang/grain/issues/1145)) ([2d43b28](https://github.com/grain-lang/grain/commit/2d43b286141df75f6b92300e48d2bc4804014872))
+* **compiler:** Convert Sys libraries to [@unsafe](https://github.com/unsafe) ([#1272](https://github.com/grain-lang/grain/issues/1272)) ([fcdfc2a](https://github.com/grain-lang/grain/commit/fcdfc2a815be889d5f0424a04dd5b2373dbd983b))
+* **compiler:** Don't close over global values ([#1134](https://github.com/grain-lang/grain/issues/1134)) ([e8caec6](https://github.com/grain-lang/grain/commit/e8caec6c2a5892e955c8827b18d8d436bebe6073))
+* **compiler:** Re-implement Grain parser ([#1033](https://github.com/grain-lang/grain/issues/1033)) ([9dc3c96](https://github.com/grain-lang/grain/commit/9dc3c96f87a0b2affe9db36e1b03360d198f79f1))
+* **compiler:** Stack-allocated Chars ([#1103](https://github.com/grain-lang/grain/issues/1103)) ([095385e](https://github.com/grain-lang/grain/commit/095385e7c67bbc7a417a21acaf6f1c498c75ce63))
+* **graindoc:** Add `--current-version` flag, required for since/history attributes ([#1116](https://github.com/grain-lang/grain/issues/1116)) ([0f681ea](https://github.com/grain-lang/grain/commit/0f681ea140749395f3ce99a460f30778537183ac))
+* **graindoc:** Allow directory input & output ([#1263](https://github.com/grain-lang/grain/issues/1263)) ([d4cb8ab](https://github.com/grain-lang/grain/commit/d4cb8abcb4accafeb3cae0bac77eee9a365e464d))
+* **grainfmt:** Allow directory input & output ([#1274](https://github.com/grain-lang/grain/issues/1274)) ([d3e7a33](https://github.com/grain-lang/grain/commit/d3e7a33b01352a9c2bcc3b17a5b2995451d92221))
+* **grainfmt:** Replace `--in-place` flag with `-o` flag ([d3e7a33](https://github.com/grain-lang/grain/commit/d3e7a33b01352a9c2bcc3b17a5b2995451d92221))
+* **stdlib:** Add module for pseudo-random number generation ([#921](https://github.com/grain-lang/grain/issues/921)) ([db1fa4e](https://github.com/grain-lang/grain/commit/db1fa4e491d35bb582beaba12157884647384a77))
+* **stdlib:** Add unsigned versions of Int32/Int64 comparison operations ([#831](https://github.com/grain-lang/grain/issues/831)) ([5f20868](https://github.com/grain-lang/grain/commit/5f20868e7b6e3f52d62c8531d99d1130ca84961e))
+* **stdlib:** Added Bytes.clear function. Avoid allocation in Buffer.clear ([#1124](https://github.com/grain-lang/grain/issues/1124)) ([4afd17a](https://github.com/grain-lang/grain/commit/4afd17a91e59027fa7af0fe58977bdbe942f8072))
+* **stdlib:** Convert runtime printing utils to [@unsafe](https://github.com/unsafe) ([#1135](https://github.com/grain-lang/grain/issues/1135)) ([403e1d2](https://github.com/grain-lang/grain/commit/403e1d20e2082fe2dcd2721f83f6c2b36d4154bf))
+
+
+### Bug Fixes
+
+* **cli:** Ensure parent flags are inherited by the format command ([d3e7a33](https://github.com/grain-lang/grain/commit/d3e7a33b01352a9c2bcc3b17a5b2995451d92221))
+* **graindoc:** Add parens around infix operators in titles ([#1303](https://github.com/grain-lang/grain/issues/1303)) ([acba9c1](https://github.com/grain-lang/grain/commit/acba9c1757688756c3ca98b22a0a159b8d8f9e7d))
+* **graindoc:** Preserve indentation in Doc comments during trim ([#1119](https://github.com/grain-lang/grain/issues/1119)) ([b8a6d57](https://github.com/grain-lang/grain/commit/b8a6d57cce274bfbc2cc16c5b25215b042d4264c))
+* **graindoc:** Remove spaces between parens and infix idents ([#1302](https://github.com/grain-lang/grain/issues/1302)) ([95e596f](https://github.com/grain-lang/grain/commit/95e596fa3fdae5a8a0e07d76ff8c11eeab99e8d7))
+* **graindoc:** Use value_descriptions and type_declarations defined by the module signature ([#1241](https://github.com/grain-lang/grain/issues/1241)) ([5896242](https://github.com/grain-lang/grain/commit/5896242c324622f3329c144bd2c9642aade9d049))
+* **grainfmt:** Remove parens around annotated types ([#1109](https://github.com/grain-lang/grain/issues/1109)) ([0ca66bd](https://github.com/grain-lang/grain/commit/0ca66bd43703826f86ef5b28b49d250af219fb0b))
+* **stdlib:** Add explicit void return type on Map.forEach ([#1220](https://github.com/grain-lang/grain/issues/1220)) ([ab2066a](https://github.com/grain-lang/grain/commit/ab2066aadffa8813344d9df7c7a10ec0f76751b6))
+* **stdlib:** Add explicit void return type on Set.forEach ([#1225](https://github.com/grain-lang/grain/issues/1225)) ([694e6cf](https://github.com/grain-lang/grain/commit/694e6cf8fcd061a77b2915dc0ea9e9b1ae143ae4))
+* **stdlib:** Align Buffer's `addStringSlice` API with String's `slice` ([#1136](https://github.com/grain-lang/grain/issues/1136)) ([0c7cb82](https://github.com/grain-lang/grain/commit/0c7cb820d49cda74598680cc614c0d893b4d2b40))
+* **stdlib:** Buffer.toBytes should not expose the raw instance of Bytes used by the buffer ([#1130](https://github.com/grain-lang/grain/issues/1130)) ([d2bb585](https://github.com/grain-lang/grain/commit/d2bb585d3e2092f1331a679f4e84a9500b8c87a5))
+* **stdlib:** Ensure Void return for forEach functions in List module ([#1307](https://github.com/grain-lang/grain/issues/1307)) ([31f480c](https://github.com/grain-lang/grain/commit/31f480c22e0a39b347fc3a48e1d0b5bd40c2f19e))
+* **stdlib:** Fix float printing in dtoa ([#1165](https://github.com/grain-lang/grain/issues/1165)) ([2987210](https://github.com/grain-lang/grain/commit/2987210648873ab474990ff2b7146a489fecb268))
+* **stdlib:** Fixed a memory leak in Buffer.addStringSlice. ([#1122](https://github.com/grain-lang/grain/issues/1122)) ([c4e1911](https://github.com/grain-lang/grain/commit/c4e19110bd9923e58a7953fcbcef18bf07f3efd6))
+* **stdlib:** Fixed length and byteLength for strings over 2GiB. ([#1126](https://github.com/grain-lang/grain/issues/1126)) ([08a9487](https://github.com/grain-lang/grain/commit/08a948709270a9aa4ac853c2887bc652c4734f36))
+* **stdlib:** Make Bytes.length handle sizes over 2GiB ([#1123](https://github.com/grain-lang/grain/issues/1123)) ([d7386eb](https://github.com/grain-lang/grain/commit/d7386eb36c32452d69a734b447015b4db23f1ac4))
+* **stdlib:** Provide correct types for BigInt operations ([#1297](https://github.com/grain-lang/grain/issues/1297)) ([fdd2f1c](https://github.com/grain-lang/grain/commit/fdd2f1c49b938a013d6ae199b5e662cb93d051e6))
+* **stdlib:** Remove intermediate resizes in Buffer.autogrow ([#1125](https://github.com/grain-lang/grain/issues/1125)) ([c1695d0](https://github.com/grain-lang/grain/commit/c1695d066ccd40b3118c5c870353addeef67bfc1))
+* **stdlib:** Use explicit exports for Pervasives ([#1301](https://github.com/grain-lang/grain/issues/1301)) ([bad5897](https://github.com/grain-lang/grain/commit/bad5897062444ec4d4ace805adcd382725b86125))
+
+
+### Miscellaneous Chores
+
+* **compiler:** Remove decRefIgnoreZeros ([#1068](https://github.com/grain-lang/grain/issues/1068)) ([3ae8eaa](https://github.com/grain-lang/grain/commit/3ae8eaabad4467304c500c2f0cc9c40749d8513b))
+* Drop node 14 support ([#1092](https://github.com/grain-lang/grain/issues/1092)) ([ef4358f](https://github.com/grain-lang/grain/commit/ef4358ff7de14a35edf3e971e04513d497fe1574))
+* **grainfmt:** Remove stdin formatting support ([d3e7a33](https://github.com/grain-lang/grain/commit/d3e7a33b01352a9c2bcc3b17a5b2995451d92221))
+* **stdlib:** Add type aliases to regex lib ([#1036](https://github.com/grain-lang/grain/issues/1036)) ([a926ea5](https://github.com/grain-lang/grain/commit/a926ea5cafa18e46487a585abbdf5460b15b4f48))
+* **stdlib:** Remove `sum` function from the List module ([#1300](https://github.com/grain-lang/grain/issues/1300)) ([9101615](https://github.com/grain-lang/grain/commit/9101615688f20310ae32573f93f36cfcf5c69be1))
+
+### [0.4.6](https://www.github.com/grain-lang/grain/compare/stdlib-v0.4.5...stdlib-v0.4.6) (2022-01-17)
+
+
+### Bug Fixes
+
+* **grainfmt:** Indent function application args when adding parens ([#1095](https://www.github.com/grain-lang/grain/issues/1095)) ([64af7d3](https://www.github.com/grain-lang/grain/commit/64af7d387dca2fddb9b3d190ccdf5790ec3d8e65))
+
+### [0.4.5](https://www.github.com/grain-lang/grain/compare/stdlib-v0.4.4...stdlib-v0.4.5) (2021-12-31)
+
+
+### Features
+
+* **stdlib:** Add sign function to Number module ([#1079](https://www.github.com/grain-lang/grain/issues/1079)) ([b6483d5](https://www.github.com/grain-lang/grain/commit/b6483d5046cd1b6b89a717a925594d3b20b05837))
+
 ### [0.4.4](https://www.github.com/grain-lang/grain/compare/stdlib-v0.4.3...stdlib-v0.4.4) (2021-12-11)
 
 

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 Oscar Spencer <oscar@grain-lang.org> and Philip Blair <philip@grain-lang.org>
+Copyright (c) 2017-2022 Oscar Spencer <oscar@grain-lang.org> and Philip Blair <philip@grain-lang.org>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/array.gr

@@ -30,7 +30,7 @@ let initPtr = () => {
 initPtr()
 
 @disableGC
-let initLength = (length) => {
+let initLength = length => {
   let length = WasmI32.fromGrain(length)
   if (WasmI32.eqz(WasmI32.and(length, 1n))) {
     throw Exception.InvalidArgument("Length argument must be an integer")
@@ -43,7 +43,7 @@ let initLength = (length) => {
 }
 
 /**
- * Returns the length of the input array.
+ * Provides the length of the input array.
  *
  * @param array: The array to inspect
  * @returns The number of elements in the array
@@ -51,7 +51,7 @@ let initLength = (length) => {
  * @since v0.1.0
  */
 @disableGC
-export let rec length = (array) => {
+export let rec length = array => {
   let ptr = WasmI32.fromGrain(array: Array<a>)
   let ret = tagSimpleNumber(WasmI32.load(ptr, _ARRAY_LENGTH_OFFSET))
   Memory.decRef(ptr)
@@ -73,15 +73,23 @@ export let rec length = (array) => {
  * @since v0.1.0
  */
 @disableGC
-export let rec make /*: (Number, a) -> Array<a>*/  = (length: Number, item: a) => {
+export let rec make /*: (Number, a) -> Array<a>*/ =
+  (
+    length: Number,
+    item: a,
+  ) => {
   let lengthArg = length
   let length = initLength(length)
   let byteLength = WasmI32.mul(length, 4n)
   let array = allocateArray(length)
   for (let mut i = 0n; WasmI32.ltS(i, byteLength); i = WasmI32.add(i, 4n)) {
-    WasmI32.store(WasmI32.add(array, i), Memory.incRef(WasmI32.fromGrain(item)), _ARRAY_START_OFFSET)
+    WasmI32.store(
+      WasmI32.add(array, i),
+      Memory.incRef(WasmI32.fromGrain(item)),
+      _ARRAY_START_OFFSET
+    )
   }
-  let ret = WasmI32.toGrain(array): (Array<a>)
+  let ret = WasmI32.toGrain(array): Array<a>
   Memory.decRef(WasmI32.fromGrain(lengthArg))
   Memory.decRef(WasmI32.fromGrain(item))
   Memory.decRef(WasmI32.fromGrain(make))
@@ -97,27 +105,35 @@ export let rec make /*: (Number, a) -> Array<a>*/  = (length: Number, item: a) =
  * @param fn: The initializer function to call with each index, where the value returned will be used to initialize the element
  * @returns The new array
  *
- * @example Array.init(5, n => n + 3) // [> 8, 9, 10, 11, 12]
+ * @example Array.init(5, n => n + 3) // [> 3, 4, 5, 6, 7]
  *
  * @since v0.1.0
  */
 @disableGC
-export let rec init /*: (Number, Number -> a) -> Array<a>*/ = (length: Number, fn: Number -> a) => {
+export let rec init /*: (Number, Number -> a) -> Array<a>*/ =
+  (
+    length: Number,
+    fn: Number -> a,
+  ) => {
   let length = initLength(length)
   let byteLength = WasmI32.mul(length, 4n)
   let array = allocateArray(length)
   let mut index = 0n
   for (let mut i = 0n; WasmI32.ltS(i, byteLength); i = WasmI32.add(i, 4n)) {
-    Memory.incRef(WasmI32.fromGrain(fn));
+    Memory.incRef(WasmI32.fromGrain(fn))
     // [FIXME] This line fails the array/map test suite (#815)
     //assert !WasmI32.eqz(WasmI32.and(WasmI32.fromGrain(index), 1n)) // must be a simple int for next line to be correct
-    WasmI32.store(WasmI32.add(array, i), WasmI32.fromGrain(fn(tagSimpleNumber(index))), _ARRAY_START_OFFSET)
+    WasmI32.store(
+      WasmI32.add(array, i),
+      WasmI32.fromGrain(fn(tagSimpleNumber(index))),
+      _ARRAY_START_OFFSET
+    )
     //WasmI32.store(WasmI32.add(array, i), WasmI32.fromGrain(4), _ARRAY_START_OFFSET)
     index = WasmI32.add(index, 1n)
   }
   Memory.decRef(WasmI32.fromGrain(fn))
   Memory.decRef(WasmI32.fromGrain(init))
-  WasmI32.toGrain(array): (Array<a>)
+  WasmI32.toGrain(array): Array<a>
 }
 
 /**
@@ -155,8 +171,8 @@ export let set = (index, value, array) => {
 }
 
 /**
- * Creates a new array with the items the first array, followed by
- * the items of the second array. This does not modify the arguments.
+ * Creates a new array with the elements of the first array followed by
+ * the elements of the second array. This does not modify the arguments.
  *
  * @param array1: The array containing elements to appear first
  * @param array2: The array containing elements to appear second
@@ -186,29 +202,29 @@ export let append = (array1, array2) => {
  *
  * @since v0.1.0
  */
-export let concat = (arrays) => {
+export let concat = arrays => {
   // This function is slightly verbose to avoid depending on the List stdlib.
 
   let rec findLength = (arrays, acc) => {
     match (arrays) {
       [fst, ...rest] => findLength(rest, acc + length(fst)),
-      [] => acc
+      [] => acc,
     }
   }
 
   let mut offset = 0
   let mut arrs = arrays
 
-  let rec next = (index) => {
+  let rec next = index => {
     let array = match (arrs) {
       [fst, ..._] => fst,
-      [] => fail "end of arrays list"
+      [] => fail "end of arrays list",
     }
     if (index - offset == length(array)) {
       offset += length(array)
       arrs = match (arrs) {
         [_, ...rest] => rest,
-        [] => fail "end of arrays list"
+        [] => fail "end of arrays list",
       }
       next(index)
     } else {
@@ -228,7 +244,7 @@ export let concat = (arrays) => {
  *
  * @since v0.1.0
  */
-export let copy = (array) => {
+export let copy = array => {
   init(length(array), n => array[n])
 }
 
@@ -245,7 +261,7 @@ export let cycle = (fn, n, array) => {
   let length = length(array)
   for (let mut iteration = 0; iteration < n; iteration += 1) {
     for (let mut count = 0; count < length; count += 1) {
-      fn(array[count]): (Void)
+      fn(array[count]): Void
     }
   }
 }
@@ -262,12 +278,12 @@ export let cycle = (fn, n, array) => {
 export let forEach = (fn, array) => {
   let length = length(array)
   for (let mut count = 0; count < length; count += 1) {
-    fn(array[count]): (Void)
+    fn(array[count]): Void
   }
 }
 
 /**
- * Iterates an array, calling an iterator function with each element.
+ * Iterates an array, calling an iterator function on each element.
  * Also passes the index as the second argument to the function.
  *
  * @param fn: The iterator function to call with each element
@@ -279,7 +295,7 @@ export let forEach = (fn, array) => {
 export let forEachi = (fn, array) => {
   let length = length(array)
   for (let mut count = 0; count < length; count += 1) {
-    fn(array[count], count): (Void)
+    fn(array[count], count): Void
   }
 }
 
@@ -296,7 +312,7 @@ export let forEachi = (fn, array) => {
  */
 export let map = (fn, array) => {
   let length = length(array)
-  init(length, (i) => {
+  init(length, i => {
     fn(array[i])
   })
 }
@@ -313,7 +329,7 @@ export let map = (fn, array) => {
  */
 export let mapi = (fn, array) => {
   let length = length(array)
-  init(length, (index) => {
+  init(length, index => {
     fn(array[index], index)
   })
 }
@@ -338,7 +354,7 @@ export let mapi = (fn, array) => {
  */
 export let reduce = (fn, initial, array) => {
   let mut acc = initial
-  forEach((el) => acc = fn(acc, el), array)
+  forEach(el => acc = fn(acc, el), array)
   acc
 }
 
@@ -387,26 +403,30 @@ export let flatMap = (fn, array) => {
  *
  * @param fn: The function to call on each element, where the returned value indicates if the element satisfies the condition
  * @param array: The array to check
- * @returns `true` if all elements satify the condition, otherwise `false`
+ * @returns `true` if all elements satify the condition or `false` otherwise
  *
  * @since v0.3.0
  */
 export let every = (fn, array) => {
-  reduce((acc, value) => { acc && fn(value) }, true, array)
+  reduce((acc, value) => {
+    acc && fn(value)
+  }, true, array)
 }
 
 /**
  * Checks that the given condition is satisfied **at least
- * once** by an item in the input array.
+ * once** by an element in the input array.
  *
  * @param fn: The function to call on each element, where the returned value indicates if the element satisfies the condition
  * @param array: The array to iterate
- * @returns `true` if one or more elements satify the condition, otherwise `false`
+ * @returns `true` if one or more elements satify the condition or `false` otherwise
  *
  * @since v0.3.0
  */
 export let some = (fn, array) => {
-  reduce((acc, value) => { acc || fn(value) }, false, array)
+  reduce((acc, value) => {
+    acc || fn(value)
+  }, false, array)
 }
 
 /**
@@ -467,9 +487,9 @@ export let fillRange = (value, start, stop, array) => {
  *
  * @since v0.4.0
  */
-export let reverse = (array) => {
+export let reverse = array => {
   let len = length(array)
-  init(len, (index) => {
+  init(len, index => {
     let last = len - index - 1
     array[last]
   })
@@ -483,7 +503,7 @@ export let reverse = (array) => {
  *
  * @since v0.1.0
  */
-export let toList = (array) => {
+export let toList = array => {
   let rec buildList = (acc, index) => {
     let index = index - 1
     if (index < 0) {
@@ -503,22 +523,22 @@ export let toList = (array) => {
  *
  * @since v0.1.0
  */
-export let fromList = (list) => {
+export let fromList = list => {
   let rec listLength = (list, acc) => {
     match (list) {
       [_, ...rest] => listLength(rest, acc + 1),
-      [] => acc
+      [] => acc,
     }
   }
 
   let mut lst = list
-  let rec next = (index) => {
+  let rec next = index => {
     match (lst) {
       [fst, ...rest] => {
         lst = rest
         fst
       },
-      [] => next(index)
+      [] => next(index),
     }
   }
   init(listLength(list, 0), next)
@@ -529,8 +549,8 @@ export let fromList = (list) => {
  * Uses the generic `==` structural equality operator.
  *
  * @param search: The value to compare
- * @param array: The array to iterate
- * @returns `true` if the value exists in the array, otherwise `false`
+ * @param array: The array to inspect
+ * @returns `true` if the value exists in the array or `false` otherwise
  *
  * @since v0.2.0
  */
@@ -549,20 +569,20 @@ export let contains = (search, array) => {
  *
  * @param fn: The function to call on each element, where the returned value indicates if the element satisfies the condition
  * @param array: The array to search
- * @returns `Some(element)` containing the first value found and `None` otherwise
+ * @returns `Some(element)` containing the first value found or `None` otherwise
  *
  * @since v0.2.0
  */
 export let find = (fn, array) => {
   let length = length(array)
-  if(length == 0){
+  if (length == 0) {
     None
   } else {
     let mut count = 0
     let mut matching = false
     let mut matchedItem = array[0]
     while (count < length) {
-      if(fn(array[count])) {
+      if (fn(array[count])) {
         matching = true
         matchedItem = array[count]
         count = length
@@ -570,7 +590,7 @@ export let find = (fn, array) => {
         count += 1
       }
     }
-    if(!matching) {
+    if (!matching) {
       None
     } else {
       Some(matchedItem)
@@ -583,20 +603,20 @@ export let find = (fn, array) => {
  *
  * @param fn: The function to call on each element, where the returned value indicates if the element satisfies the condition
  * @param array: The array to search
- * @returns `Some(index)` containing the index of the first element found and `None` otherwise
+ * @returns `Some(index)` containing the index of the first element found or `None` otherwise
  *
  * @since v0.2.0
  */
 export let findIndex = (fn, array) => {
   let length = length(array)
-  if(length == 0){
+  if (length == 0) {
     None
   } else {
     let mut count = 0
     let mut matching = false
     let mut matchedIndex = 0
     while (count < length) {
-      if(fn(array[count])) {
+      if (fn(array[count])) {
         matching = true
         matchedIndex = count
         count = length
@@ -604,7 +624,7 @@ export let findIndex = (fn, array) => {
         count += 1
       }
     }
-    if(!matching) {
+    if (!matching) {
       None
     } else {
       Some(matchedIndex)
@@ -628,7 +648,7 @@ export let product = (array1: Array<a>, array2: Array<b>) => {
   let mut indexA = -1
 
   init(lenA * lenB, n => {
-    if(n % lenB == 0){
+    if (n % lenB == 0) {
       indexA += 1
     } else {
       indexA = indexA
@@ -651,7 +671,7 @@ export let count = (fn, array) => {
   let mut position = 0
   let mut count = 0
   for (let mut position = 0; position < length; position += 1) {
-    if(fn(array[position])) {
+    if (fn(array[position])) {
       count += 1
     }
   }
@@ -693,13 +713,13 @@ export let counti = (fn, array) => {
 export let filter = (fn, array) => {
   let filtered = copy(array)
   let mut position = 0
-  forEach((el) => {
+  forEach(el => {
     if (fn(el)) {
       filtered[position] = el
       position += 1
     }
   }, array)
-  init(position, (index) => {
+  init(position, index => {
     filtered[index]
   })
 }
@@ -724,7 +744,7 @@ export let filteri = (fn, array) => {
       position += 1
     }
   }, array)
-  init(position, (index) => {
+  init(position, index => {
     filtered[index]
   })
 }
@@ -738,11 +758,9 @@ export let filteri = (fn, array) => {
  *
  * @since v0.3.0
  */
-export let unique = (array) => {
-  filteri(
-    (el, index) => findIndex(value => value == el, array) == Some(index),
-    array
-  )
+export let unique = array => {
+  filteri((el, index) =>
+    findIndex(value => value == el, array) == Some(index), array)
 }
 
 /**
@@ -777,15 +795,17 @@ export let zip = (array1: Array<a>, array2: Array<b>) => {
  *
  * @since v0.4.0
  */
-export let unzip = (array) => {
+export let unzip = array => {
   let lenArr = length(array)
 
   let a = init(lenArr, n => {
-    let (fst, _) = array[n]; fst
+    let (fst, _) = array[n]
+    fst
   })
 
   let b = init(lenArr, n => {
-    let (_, snd) = array[n]; snd
+    let (_, snd) = array[n]
+    snd
   })
 
   (a, b)
@@ -804,10 +824,10 @@ export let join = (separator: String, items: Array<String>) => {
   let iter = (acc, str) => {
     match (acc) {
       None => Some(str),
-      Some(prev) => Some(prev ++ separator ++ str)
+      Some(prev) => Some(prev ++ separator ++ str),
     }
   }
-  match(reduce(iter, None, items)) {
+  match (reduce(iter, None, items)) {
     None => "",
     Some(s) => s,
   }
@@ -850,7 +870,7 @@ export let slice = (startIndex, endIndex, array) => {
     endIndex
   }
 
-  let newLength = endIndex - startIndex;
+  let newLength = endIndex - startIndex
   if (newLength < 0) {
     [>]
   } else if (newLength > arrayLength) {
@@ -872,8 +892,8 @@ export let sort = (comp, array) => {
   let partition = (low, high) => {
     let pivot = array[high]
     let mut i = low - 1
-    for(let mut j = low; j < high; j += 1) {
-      if(comp(array[j], pivot) < 0){
+    for (let mut j = low; j < high; j += 1) {
+      if (comp(array[j], pivot) < 0) {
         i += 1
         let temp = array[i]
         array[i] = array[j]
@@ -886,7 +906,7 @@ export let sort = (comp, array) => {
     i + 1
   }
   let rec quicksort = (low, high) => {
-    if(low < high){
+    if (low < high) {
       let partitionIndex = partition(low, high)
       quicksort(partitionIndex + 1, high)
       quicksort(low, partitionIndex - 1)
@@ -897,10 +917,10 @@ export let sort = (comp, array) => {
 }
 
 /**
- * Rotates an array by n elements to the right, in place.
+ * Rotates array elements by the specified amount to the right, in place.
  *
- * If n is negative, the array will be rotated by n elements
- * to the left. See examples.
+ * If value is negative, array elements will be rotated by the
+ * specified amount to the left. See examples.
  *
  * @param n: The number of elements to rotate by
  * @param arr: The array to be rotated
@@ -913,8 +933,7 @@ export let rotate = (n, arr) => {
   let rec gcd = (a, b) => {
     if (b == 0) {
       a
-    }
-    else{
+    } else {
       gcd(b, a % b)
     }
   }
@@ -923,7 +942,7 @@ export let rotate = (n, arr) => {
   if (arrLen > 0) {
     let k = n % arrLen
     let mut d = -1
-    let mut j  = 0
+    let mut j = 0
     for (let mut i = 0; i < gcd(arrLen, k); i += 1) {
       j = i
       let temp = arr[i]