@grain/stdlib 0.4.0 → 0.4.4

package/hash.md

@@ -0,0 +1,44 @@
+---
+title: Hash
+---
+
+Utilities for hashing any value.
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.1.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+import Hash from "hash"
+```
+
+## Values
+
+Functions for hashing.
+
+### Hash.**hash**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.1.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+hash : a -> Number
+```
+
+A generic hash function that produces an integer from any value. If `a == b` then `Hash.hash(a) == Hash.hash(b)`.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`anything`|`a`|The value to hash|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|A hash for the given value|
+

package/list.gr

@@ -329,3 +329,57 @@ let join = (separator: String, items: List<String>) => {
     Some(s) => s,
   }
 }
+
+/**
+ * Reverses the first list and appends the second list to the end.
+ * 
+ * @param list1: The list to reverse
+ * @param list2: The list to append
+ * @since v0.4.5
+ */
+let rec revAppend = (list1, list2) => { 
+  match (list1) {
+    [hd, ...tl] => revAppend(tl, [hd, ...list2]),
+    [] => list2
+  }
+}
+
+/**
+ * Sorts the given list based on a given comparator function. The resulting list is sorted in increasing order.
+ * 
+ * Ordering is calculated using a comparator function which takes two list elements and must return 0 if both are equal, a positive number if the first is greater, and a negative number if the first is smaller.
+ * @param comp: The comparator function used to indicate sort order
+ * @param list: The list to be sorted
+ * @since v0.4.5
+ */
+let sort = (comp, list) => { 
+  let rec merge = (left, right, list) => {
+    match((left, right)){
+      (_, []) => {
+        revAppend(list, left)
+      },
+      ([], _) => {
+        revAppend(list, right)
+      },
+      ([lhd, ...ltl], [rhd, ...rtl]) => {
+        if(comp(lhd, rhd) < 0){
+          merge(ltl, right, append([lhd],list))
+        }else{
+          merge(left, rtl, append([rhd], list))
+        }
+      }
+    }
+  }
+
+  let rec mergesort = (list) => {
+    if(length(list) <= 1){
+      list
+    }else{
+      let middle = length(list) / 2
+      let (left, right) = part(middle, list)
+      merge(mergesort(left), mergesort(right), [])
+    }
+  }
+
+  mergesort(list)
+}

package/number.gr

@@ -15,6 +15,7 @@ import {
   isFloat,
   isBoxedNumber
 } from "runtime/numbers"
+import { parseInt } from "runtime/stringUtils"
 import { newFloat64, newInt64 } from "runtime/dataStructures"
 import Tags from "runtime/unsafe/tags"
 
@@ -76,9 +77,9 @@ export let rec sqrt = (x: Number) => {
   let x = WasmI32.fromGrain(x)
   let sqrtd = WasmF64.sqrt(xval)
   let ret = if (!isFloat(x) && WasmF64.eq(sqrtd, WasmF64.trunc(sqrtd))) {
-    WasmI32.toGrain(reducedInteger(WasmI64.truncF64S(sqrtd))): Number
+    WasmI32.toGrain(reducedInteger(WasmI64.truncF64S(sqrtd))): (Number)
   } else {
-    WasmI32.toGrain(newFloat64(sqrtd)): Number
+    WasmI32.toGrain(newFloat64(sqrtd)): (Number)
   }
   Memory.decRef(WasmI32.fromGrain(x))
   Memory.decRef(WasmI32.fromGrain(sqrt))
@@ -119,7 +120,7 @@ export let max = (x: Number, y: Number) => if (x > y) x else y
 export let rec ceil = (x: Number) => {
   let xval = coerceNumberToWasmF64(x)
   let ceiling = WasmI64.truncF64S(WasmF64.ceil(xval))
-  let ret = WasmI32.toGrain(reducedInteger(ceiling)): Number
+  let ret = WasmI32.toGrain(reducedInteger(ceiling)): (Number)
   Memory.decRef(WasmI32.fromGrain(x))
   Memory.decRef(WasmI32.fromGrain(ceil))
   ret
@@ -137,7 +138,7 @@ export let rec ceil = (x: Number) => {
 export let rec floor = (x: Number) => {
   let xval = coerceNumberToWasmF64(x)
   let floored = WasmI64.truncF64S(WasmF64.floor(xval))
-  let ret = WasmI32.toGrain(reducedInteger(floored)): Number
+  let ret = WasmI32.toGrain(reducedInteger(floored)): (Number)
   Memory.decRef(WasmI32.fromGrain(x))
   Memory.decRef(WasmI32.fromGrain(floor))
   ret
@@ -155,7 +156,7 @@ export let rec floor = (x: Number) => {
 export let rec trunc = (x: Number) => {
   let xval = coerceNumberToWasmF64(x)
   let trunced = WasmI64.truncF64S(xval)
-  let ret = WasmI32.toGrain(reducedInteger(trunced)): Number
+  let ret = WasmI32.toGrain(reducedInteger(trunced)): (Number)
   Memory.decRef(WasmI32.fromGrain(x))
   Memory.decRef(WasmI32.fromGrain(trunc))
   ret
@@ -173,7 +174,7 @@ export let rec trunc = (x: Number) => {
 export let rec round = (x: Number) => {
   let xval = coerceNumberToWasmF64(x)
   let rounded = WasmI64.truncF64S(WasmF64.nearest(xval))
-  let ret = WasmI32.toGrain(reducedInteger(rounded)): Number
+  let ret = WasmI32.toGrain(reducedInteger(rounded)): (Number)
   Memory.decRef(WasmI32.fromGrain(x))
   Memory.decRef(WasmI32.fromGrain(round))
   ret
@@ -305,3 +306,20 @@ export let rec isInfinite = (x: Number) => {
   Memory.decRef(WasmI32.fromGrain(isInfinite))
   ret
 }
+
+/**
+ * Parses a string representation of an integer into a `Number` using the
+ * specified radix (also known as a number system "base").
+ * 
+ * If the string has a radix prefix (i.e. "0x"/"0X", "0o"/"0O", or "0b"/"0B"
+ * for radixes 16, 8, or 2 respectively), the supplied radix is ignored in
+ * favor of the prefix. Underscores that appear in the numeric portion of the
+ * input are ignored.
+ * 
+ * @param input: The string to parse
+ * @param radix: The number system base to use when parsing the input string
+ * @returns `Ok(value)` containing the parsed number on a successful parse or `Err(msg)` containing an error message string otherwise
+ * 
+ * @since v0.4.5
+ */
+export parseInt

package/number.md

@@ -5,7 +5,7 @@ title: Number
 Utilities for working with numbers.
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -16,7 +16,7 @@ import Number from "number"
 ### Number.**add**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -42,7 +42,7 @@ Returns:
 ### Number.**sub**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -68,7 +68,7 @@ Returns:
 ### Number.**mul**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -94,7 +94,7 @@ Returns:
 ### Number.**div**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -120,7 +120,7 @@ Returns:
 ### Number.**sqrt**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -145,7 +145,7 @@ Returns:
 ### Number.**min**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -171,7 +171,7 @@ Returns:
 ### Number.**max**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -197,7 +197,7 @@ Returns:
 ### Number.**ceil**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -222,7 +222,7 @@ Returns:
 ### Number.**floor**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -247,7 +247,7 @@ Returns:
 ### Number.**trunc**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -272,7 +272,7 @@ Returns:
 ### Number.**round**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -297,7 +297,7 @@ Returns:
 ### Number.**abs**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -322,7 +322,7 @@ Returns:
 ### Number.**neg**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -347,7 +347,7 @@ Returns:
 ### Number.**isFinite**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -373,7 +373,7 @@ Returns:
 ### Number.**isNaN**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -399,7 +399,7 @@ Returns:
 ### Number.**isInfinite**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
 No other changes yet.
 </details>
 
@@ -422,3 +422,35 @@ Returns:
 |----|-----------|
 |`Bool`|`true` if the value is infinite, otherwise `false`|
 
+### Number.**parseInt**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+parseInt : (String, Number) -> Result<Number, String>
+```
+
+Parses a string representation of an integer into a `Number` using the
+specified radix (also known as a number system "base").
+
+If the string has a radix prefix (i.e. "0x"/"0X", "0o"/"0O", or "0b"/"0B"
+for radixes 16, 8, or 2 respectively), the supplied radix is ignored in
+favor of the prefix. Underscores that appear in the numeric portion of the
+input are ignored.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`input`|`String`|The string to parse|
+|`radix`|`Number`|The number system base to use when parsing the input string|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Result<Number, String>`|`Ok(value)` containing the parsed number on a successful parse or `Err(msg)` containing an error message string otherwise|
+