@grain/stdlib 0.4.6 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,78 @@
 # 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)
 
 

package/array.gr

@@ -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
@@ -52,7 +52,7 @@ let initLength = length => {
  */
 @disableGC
 export let rec length = array => {
-  let ptr = WasmI32.fromGrain(array: (Array<a>))
+  let ptr = WasmI32.fromGrain(array: Array<a>)
   let ret = tagSimpleNumber(WasmI32.load(ptr, _ARRAY_LENGTH_OFFSET))
   Memory.decRef(ptr)
   Memory.decRef(WasmI32.fromGrain(length))
@@ -89,7 +89,7 @@ export let rec make /*: (Number, a) -> Array<a>*/ =
       _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))
@@ -105,7 +105,7 @@ export let rec make /*: (Number, a) -> Array<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
  */
@@ -133,7 +133,7 @@ export let rec init /*: (Number, Number -> a) -> Array<a>*/ =
   }
   Memory.decRef(WasmI32.fromGrain(fn))
   Memory.decRef(WasmI32.fromGrain(init))
-  WasmI32.toGrain(array): (Array<a>)
+  WasmI32.toGrain(array): Array<a>
 }
 
 /**
@@ -171,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
@@ -283,7 +283,7 @@ export let forEach = (fn, array) => {
 }
 
 /**
- * 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
@@ -403,7 +403,7 @@ 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
  */
@@ -415,11 +415,11 @@ export let every = (fn, 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
  */
@@ -549,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
  */
@@ -569,7 +569,7 @@ 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
  */
@@ -603,7 +603,7 @@ 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
  */
@@ -917,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

package/array.md

@@ -36,7 +36,7 @@ No other changes yet.
 length : Array<a> -> Number
 ```
 
-Returns the length of the input array.
+Provides the length of the input array.
 
 Parameters:
 
@@ -114,7 +114,7 @@ Returns:
 Examples:
 
 ```grain
-Array.init(5, n => n + 3) // [> 8, 9, 10, 11, 12]
+Array.init(5, n => n + 3) // [> 3, 4, 5, 6, 7]
 ```
 
 ### Array.**get**
@@ -195,8 +195,8 @@ No other changes yet.
 append : (Array<a>, Array<a>) -> Array<a>
 ```
 
-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.
 
 Parameters:
 
@@ -266,7 +266,7 @@ Returns:
 ### Array.**cycle**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.4</code></summary>
 No other changes yet.
 </details>
 
@@ -329,7 +329,7 @@ Parameters:
 forEachi : (((a, Number) -> Void), Array<a>) -> 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.
 
 Parameters:
@@ -527,7 +527,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Bool`|`true` if all elements satify the condition, otherwise `false`|
+|`Bool`|`true` if all elements satify the condition or `false` otherwise|
 
 ### Array.**some**
 
@@ -541,7 +541,7 @@ some : ((a -> Bool), Array<a>) -> Bool
 ```
 
 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.
 
 Parameters:
 
@@ -554,7 +554,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Bool`|`true` if one or more elements satify the condition, otherwise `false`|
+|`Bool`|`true` if one or more elements satify the condition or `false` otherwise|
 
 ### Array.**fill**
 
@@ -693,13 +693,13 @@ Parameters:
 |param|type|description|
 |-----|----|-----------|
 |`search`|`a`|The value to compare|
-|`array`|`Array<a>`|The array to iterate|
+|`array`|`Array<a>`|The array to inspect|
 
 Returns:
 
 |type|description|
 |----|-----------|
-|`Bool`|`true` if the value exists in the array, otherwise `false`|
+|`Bool`|`true` if the value exists in the array or `false` otherwise|
 
 ### Array.**find**
 
@@ -725,7 +725,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Option<a>`|`Some(element)` containing the first value found and `None` otherwise|
+|`Option<a>`|`Some(element)` containing the first value found or `None` otherwise|
 
 ### Array.**findIndex**
 
@@ -751,7 +751,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Option<Number>`|`Some(index)` containing the index of the first element found and `None` otherwise|
+|`Option<Number>`|`Some(index)` containing the index of the first element found or `None` otherwise|
 
 ### Array.**product**
 
@@ -1030,7 +1030,7 @@ Returns:
 ### Array.**sort**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.5</code></summary>
 No other changes yet.
 </details>
 
@@ -1052,7 +1052,7 @@ Parameters:
 ### Array.**rotate**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.5</code></summary>
 No other changes yet.
 </details>
 
@@ -1060,10 +1060,10 @@ No other changes yet.
 rotate : (Number, Array<a>) -> Void
 ```
 
-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.
 
 Parameters: