@grain/stdlib 0.6.5 → 0.7.0

package/map.gr

@@ -14,7 +14,6 @@ from "option" include Option
 from "runtime/dataStructures" include DataStructures
 use DataStructures.{ allocateArray, untagSimpleNumber }
 from "hash" include Hash
-use Hash.{ hash }
 from "runtime/unsafe/memory" include Memory
 from "runtime/unsafe/wasmi32" include WasmI32
 
@@ -27,6 +26,7 @@ record rec Bucket<k, v> {
 
 abstract record Map<k, v> {
   mut size: Number,
+  hashInstance: Hash.HashInstance,
   mut buckets: Array<Option<Bucket<k, v>>>,
 }
 
@@ -47,25 +47,28 @@ provide record InternalMapStats {
  * @param size: The initial storage size of the map
  * @returns An empty map with the given initial storage size
  *
+ * @throws Failure(String): If WASI random_get fails
+ *
  * @since v0.2.0
  * @history v0.6.0: Merged with `makeSized`; modified signature to accept size
  */
 provide let make = (size=16) => { // TODO: This could take an `eq` function to custom comparisons
   let buckets = Array.make(size, None)
-  { size: 0, buckets }
+  let hashInstance = Hash.make()
+  { size: 0, hashInstance, buckets }
 }
 
-let getBucketIndex = (key, buckets) => {
+let getBucketIndex = (hashInstance, key, buckets) => {
   let bucketsLength = Array.length(buckets)
-  let hashedKey = hash(key)
+  let hashedKey = Hash.hash(hashInstance, key)
   hashedKey % bucketsLength
 }
 
-let rec copyNodeWithNewHash = (oldNode, next, tail) => {
+let rec copyNodeWithNewHash = (hashInstance, oldNode, next, tail) => {
   match (oldNode) {
     None => void,
     Some(node) => {
-      let idx = getBucketIndex(node.key, next)
+      let idx = getBucketIndex(hashInstance, node.key, next)
       let newNode = Some(node)
       match (tail[idx]) {
         None => {
@@ -79,7 +82,7 @@ let rec copyNodeWithNewHash = (oldNode, next, tail) => {
       // Always place this node as the new tail
       tail[idx] = newNode
       // Recurse with the next node
-      copyNodeWithNewHash(node.next, next, tail)
+      copyNodeWithNewHash(hashInstance, node.next, next, tail)
     },
   }
 }
@@ -93,8 +96,9 @@ let resize = map => {
     // This tracks the tail nodes so we can set their `next` to None
     let tailNodes = Array.make(nextSize, None)
     map.buckets = nextBuckets
+    let hashInstance = map.hashInstance
     Array.forEach(old => {
-      copyNodeWithNewHash(old, nextBuckets, tailNodes)
+      copyNodeWithNewHash(hashInstance, old, nextBuckets, tailNodes)
     }, currentBuckets)
     Array.forEach(tail => {
       match (tail) {
@@ -132,7 +136,8 @@ let rec replaceInBucket = (key, value, node) => {
  */
 provide let set = (key, value, map) => {
   let buckets = map.buckets
-  let idx = getBucketIndex(key, buckets)
+  let hashInstance = map.hashInstance
+  let idx = getBucketIndex(hashInstance, key, buckets)
   let bucket = buckets[idx]
   match (bucket) {
     None => {
@@ -176,7 +181,8 @@ let rec valueFromBucket = (key, node) => {
  */
 provide let get = (key, map) => {
   let buckets = map.buckets
-  let idx = getBucketIndex(key, buckets)
+  let hashInstance = map.hashInstance
+  let idx = getBucketIndex(hashInstance, key, buckets)
   let bucket = buckets[idx]
   match (bucket) {
     None => None,
@@ -206,7 +212,8 @@ let rec nodeInBucket = (key, node) => {
  */
 provide let contains = (key, map) => {
   let buckets = map.buckets
-  let idx = getBucketIndex(key, buckets)
+  let hashInstance = map.hashInstance
+  let idx = getBucketIndex(hashInstance, key, buckets)
   let bucket = buckets[idx]
   match (bucket) {
     None => false,
@@ -238,7 +245,8 @@ let rec removeInBucket = (key, node) => {
  */
 provide let remove = (key, map) => {
   let buckets = map.buckets
-  let idx = getBucketIndex(key, buckets)
+  let hashInstance = map.hashInstance
+  let idx = getBucketIndex(hashInstance, key, buckets)
   let bucket = buckets[idx]
   match (bucket) {
     None => void,

package/map.md

@@ -55,7 +55,7 @@ Functions and constants included in the Map module.
 </details>
 
 ```grain
-make : (?size: Number) => Map<a, b>
+make: (?size: Number) => Map<a, b>
 ```
 
 Creates a new empty map with an initial storage of the given size. As
@@ -75,6 +75,12 @@ Returns:
 |----|-----------|
 |`Map<a, b>`|An empty map with the given initial storage size|
 
+Throws:
+
+`Failure(String)`
+
+* If WASI random_get fails
+
 ### Map.**set**
 
 <details disabled>
@@ -83,7 +89,7 @@ No other changes yet.
 </details>
 
 ```grain
-set : (key: a, value: b, map: Map<a, b>) => Void
+set: (key: a, value: b, map: Map<a, b>) => Void
 ```
 
 Adds a new key-value pair to the map. If the key already exists in the map, the value is replaced.
@@ -104,7 +110,7 @@ No other changes yet.
 </details>
 
 ```grain
-get : (key: a, map: Map<a, b>) => Option<b>
+get: (key: a, map: Map<a, b>) => Option<b>
 ```
 
 Retrieves the value for the given key.
@@ -130,7 +136,7 @@ No other changes yet.
 </details>
 
 ```grain
-contains : (key: a, map: Map<a, b>) => Bool
+contains: (key: a, map: Map<a, b>) => Bool
 ```
 
 Determines if the map contains the given key. In such a case, it will always contain a value for the given key.
@@ -156,7 +162,7 @@ No other changes yet.
 </details>
 
 ```grain
-remove : (key: a, map: Map<a, b>) => Void
+remove: (key: a, map: Map<a, b>) => Void
 ```
 
 Removes the given key from the map, which also removes the value. If the key pair doesn't exist, nothing happens.
@@ -176,7 +182,7 @@ No other changes yet.
 </details>
 
 ```grain
-update : (key: a, fn: (Option<b> => Option<b>), map: Map<a, b>) => Void
+update: (key: a, fn: (Option<b> => Option<b>), map: Map<a, b>) => Void
 ```
 
 Updates a value in the map by calling an updater function that receives the previously stored value as an `Option` and returns the new value to be stored as an `Option`. If the key didn't exist previously, the value will be `None`. If `None` is returned from the updater function, the key-value pair is removed.
@@ -197,7 +203,7 @@ No other changes yet.
 </details>
 
 ```grain
-size : (map: Map<a, b>) => Number
+size: (map: Map<a, b>) => Number
 ```
 
 Provides the count of key-value pairs stored within the map.
@@ -222,7 +228,7 @@ No other changes yet.
 </details>
 
 ```grain
-isEmpty : (map: Map<a, b>) => Bool
+isEmpty: (map: Map<a, b>) => Bool
 ```
 
 Determines if the map contains no key-value pairs.
@@ -247,7 +253,7 @@ No other changes yet.
 </details>
 
 ```grain
-clear : (map: Map<a, b>) => Void
+clear: (map: Map<a, b>) => Void
 ```
 
 Resets the map by removing all key-value pairs.
@@ -273,7 +279,7 @@ Parameters:
 </details>
 
 ```grain
-forEach : (fn: ((a, b) => Void), map: Map<a, b>) => Void
+forEach: (fn: ((a, b) => Void), map: Map<a, b>) => Void
 ```
 
 Iterates the map, calling an iterator function with each key and value.
@@ -293,7 +299,7 @@ No other changes yet.
 </details>
 
 ```grain
-reduce : (fn: ((a, b, c) => a), init: a, map: Map<b, c>) => a
+reduce: (fn: ((a, b, c) => a), init: a, map: Map<b, c>) => a
 ```
 
 Combines all key-value pairs of a map using a reducer function.
@@ -320,7 +326,7 @@ No other changes yet.
 </details>
 
 ```grain
-keys : (map: Map<a, b>) => List<a>
+keys: (map: Map<a, b>) => List<a>
 ```
 
 Enumerates all keys in the given map.
@@ -345,7 +351,7 @@ No other changes yet.
 </details>
 
 ```grain
-values : (map: Map<a, b>) => List<b>
+values: (map: Map<a, b>) => List<b>
 ```
 
 Enumerates all values in the given map.
@@ -370,7 +376,7 @@ No other changes yet.
 </details>
 
 ```grain
-toList : (map: Map<a, b>) => List<(a, b)>
+toList: (map: Map<a, b>) => List<(a, b)>
 ```
 
 Enumerates all key-value pairs in the given map.
@@ -395,7 +401,7 @@ No other changes yet.
 </details>
 
 ```grain
-fromList : (list: List<(a, b)>) => Map<a, b>
+fromList: (list: List<(a, b)>) => Map<a, b>
 ```
 
 Creates a map from a list.
@@ -420,7 +426,7 @@ No other changes yet.
 </details>
 
 ```grain
-toArray : (map: Map<a, b>) => Array<(a, b)>
+toArray: (map: Map<a, b>) => Array<(a, b)>
 ```
 
 Converts a map into an array of its key-value pairs.
@@ -445,7 +451,7 @@ No other changes yet.
 </details>
 
 ```grain
-fromArray : (array: Array<(a, b)>) => Map<a, b>
+fromArray: (array: Array<(a, b)>) => Map<a, b>
 ```
 
 Creates a map from an array.
@@ -470,7 +476,7 @@ No other changes yet.
 </details>
 
 ```grain
-filter : (fn: ((a, b) => Bool), map: Map<a, b>) => Void
+filter: (fn: ((a, b) => Bool), map: Map<a, b>) => Void
 ```
 
 Removes key-value pairs from a map where a predicate function returns `false`.
@@ -490,7 +496,7 @@ No other changes yet.
 </details>
 
 ```grain
-reject : (fn: ((a, b) => Bool), map: Map<a, b>) => Void
+reject: (fn: ((a, b) => Bool), map: Map<a, b>) => Void
 ```
 
 Removes key-value pairs from a map where a predicate function returns `true`.
@@ -517,7 +523,7 @@ Parameters:
 </details>
 
 ```grain
-getInternalStats : (map: Map<a, b>) => InternalMapStats
+getInternalStats: (map: Map<a, b>) => InternalMapStats
 ```
 
 Provides data representing the internal state state of the map.
@@ -579,7 +585,7 @@ Functions and constants included in the Map.Immutable module.
 </details>
 
 ```grain
-empty : Map<a, b>
+empty: Map<a, b>
 ```
 
 An empty map
@@ -599,7 +605,7 @@ An empty map
 </details>
 
 ```grain
-size : (map: Map<a, b>) => Number
+size: (map: Map<a, b>) => Number
 ```
 
 Provides the count of key-value pairs stored within the map.
@@ -631,7 +637,7 @@ Returns:
 </details>
 
 ```grain
-isEmpty : (map: Map<a, b>) => Bool
+isEmpty: (map: Map<a, b>) => Bool
 ```
 
 Determines if the map contains no key-value pairs.
@@ -663,7 +669,7 @@ Returns:
 </details>
 
 ```grain
-set : (key: a, value: b, map: Map<a, b>) => Map<a, b>
+set: (key: a, value: b, map: Map<a, b>) => Map<a, b>
 ```
 
 Produces a new map containing a new key-value pair. If the key already exists in the map, the value is replaced.
@@ -697,7 +703,7 @@ Returns:
 </details>
 
 ```grain
-get : (key: a, map: Map<a, b>) => Option<b>
+get: (key: a, map: Map<a, b>) => Option<b>
 ```
 
 Retrieves the value for the given key.
@@ -730,7 +736,7 @@ Returns:
 </details>
 
 ```grain
-contains : (key: a, map: Map<a, b>) => Bool
+contains: (key: a, map: Map<a, b>) => Bool
 ```
 
 Determines if the map contains the given key. In such a case, it will always contain a value for the given key.
@@ -763,7 +769,7 @@ Returns:
 </details>
 
 ```grain
-remove : (key: a, map: Map<a, b>) => Map<a, b>
+remove: (key: a, map: Map<a, b>) => Map<a, b>
 ```
 
 Produces a new map without the key-value pair corresponding to the given
@@ -797,7 +803,7 @@ Returns:
 </details>
 
 ```grain
-update : (key: a, fn: (Option<b> => Option<b>), map: Map<a, b>) => Map<a, b>
+update: (key: a, fn: (Option<b> => Option<b>), map: Map<a, b>) => Map<a, b>
 ```
 
 Produces a new map by calling an updater function that receives the
@@ -835,7 +841,7 @@ Returns:
 </details>
 
 ```grain
-forEach : (fn: ((a, b) => Void), map: Map<a, b>) => Void
+forEach: (fn: ((a, b) => Void), map: Map<a, b>) => Void
 ```
 
 Iterates the map, calling an iterator function with each key and value.
@@ -862,7 +868,7 @@ Parameters:
 </details>
 
 ```grain
-reduce : (fn: ((a, b, c) => a), init: a, map: Map<b, c>) => a
+reduce: (fn: ((a, b, c) => a), init: a, map: Map<b, c>) => a
 ```
 
 Combines all key-value pairs of a map using a reducer function.
@@ -896,7 +902,7 @@ Returns:
 </details>
 
 ```grain
-keys : (map: Map<a, b>) => List<a>
+keys: (map: Map<a, b>) => List<a>
 ```
 
 Enumerates all keys in the given map.
@@ -928,7 +934,7 @@ Returns:
 </details>
 
 ```grain
-values : (map: Map<a, b>) => List<b>
+values: (map: Map<a, b>) => List<b>
 ```
 
 Enumerates all values in the given map.
@@ -960,7 +966,7 @@ Returns:
 </details>
 
 ```grain
-filter : (fn: ((a, b) => Bool), map: Map<a, b>) => Map<a, b>
+filter: (fn: ((a, b) => Bool), map: Map<a, b>) => Map<a, b>
 ```
 
 Produces a new map excluding the key-value pairs where a predicate function returns `false`.
@@ -993,7 +999,7 @@ Returns:
 </details>
 
 ```grain
-reject : (fn: ((a, b) => Bool), map: Map<a, b>) => Map<a, b>
+reject: (fn: ((a, b) => Bool), map: Map<a, b>) => Map<a, b>
 ```
 
 Produces a new map excluding the key-value pairs where a predicate function returns `true`.
@@ -1026,7 +1032,7 @@ Returns:
 </details>
 
 ```grain
-fromList : (list: List<(a, b)>) => Map<a, b>
+fromList: (list: List<(a, b)>) => Map<a, b>
 ```
 
 Creates a map from a list.
@@ -1058,7 +1064,7 @@ Returns:
 </details>
 
 ```grain
-toList : (map: Map<a, b>) => List<(a, b)>
+toList: (map: Map<a, b>) => List<(a, b)>
 ```
 
 Enumerates all key-value pairs in the given map.
@@ -1090,7 +1096,7 @@ Returns:
 </details>
 
 ```grain
-fromArray : (array: Array<(a, b)>) => Map<a, b>
+fromArray: (array: Array<(a, b)>) => Map<a, b>
 ```
 
 Creates a map from an array.
@@ -1122,7 +1128,7 @@ Returns:
 </details>
 
 ```grain
-toArray : (map: Map<a, b>) => Array<(a, b)>
+toArray: (map: Map<a, b>) => Array<(a, b)>
 ```
 
 Converts a map into an array of its key-value pairs.

package/marshal.gr

@@ -75,8 +75,8 @@ let rec size = (value, acc, valuesSeen, toplevel) => {
       }
       let heapPtr = value
       match (load(heapPtr, 0n)) {
-        t when t == Tags._GRAIN_STRING_HEAP_TAG ||
-          t == Tags._GRAIN_BYTES_HEAP_TAG => {
+        t when t == Tags._GRAIN_STRING_HEAP_TAG
+          || t == Tags._GRAIN_BYTES_HEAP_TAG => {
           acc + roundTo8(8n + load(heapPtr, 4n))
         },
         t when t == Tags._GRAIN_ADT_HEAP_TAG => {
@@ -142,27 +142,27 @@ let rec size = (value, acc, valuesSeen, toplevel) => {
         t when t == Tags._GRAIN_BOXED_NUM_HEAP_TAG => {
           let tag = load(heapPtr, 4n)
           match (tag) {
-            t when t == Tags._GRAIN_INT64_BOXED_NUM_TAG ||
-              t == Tags._GRAIN_FLOAT64_BOXED_NUM_TAG => {
+            t when t == Tags._GRAIN_INT64_BOXED_NUM_TAG
+              || t == Tags._GRAIN_FLOAT64_BOXED_NUM_TAG => {
               acc + 16n
             },
             t when t == Tags._GRAIN_BIGINT_BOXED_NUM_TAG => {
               acc + 16n + load(heapPtr, 8n) * 8n
             },
             t when t == Tags._GRAIN_RATIONAL_BOXED_NUM_TAG => {
-              acc +
-                16n +
-                size(load(value, 8n), 0n, valuesSeen, false) +
-                size(load(value, 12n), 0n, valuesSeen, false)
+              acc
+                + 16n
+                + size(load(value, 8n), 0n, valuesSeen, false)
+                + size(load(value, 12n), 0n, valuesSeen, false)
             },
             _ => {
               fail "Unknown number type"
             },
           }
         },
-        t when t == Tags._GRAIN_INT32_HEAP_TAG ||
-          t == Tags._GRAIN_FLOAT32_HEAP_TAG ||
-          t == Tags._GRAIN_UINT32_HEAP_TAG => {
+        t when t == Tags._GRAIN_INT32_HEAP_TAG
+          || t == Tags._GRAIN_FLOAT32_HEAP_TAG
+          || t == Tags._GRAIN_UINT32_HEAP_TAG => {
           acc + 8n
         },
         t when t == Tags._GRAIN_UINT64_HEAP_TAG => {
@@ -386,9 +386,9 @@ let rec marshalHeap = (heapPtr, buf, offset, valuesSeen) => {
         },
       }
     },
-    t when t == Tags._GRAIN_INT32_HEAP_TAG ||
-      t == Tags._GRAIN_FLOAT32_HEAP_TAG ||
-      t == Tags._GRAIN_UINT32_HEAP_TAG => {
+    t when t == Tags._GRAIN_INT32_HEAP_TAG
+      || t == Tags._GRAIN_FLOAT32_HEAP_TAG
+      || t == Tags._GRAIN_UINT32_HEAP_TAG => {
       Memory.copy(buf + offset, heapPtr, 8n)
       offset + 8n
     },
@@ -449,11 +449,11 @@ let reportError = (message, offset) => {
 @unsafe
 let validateStack = (value, offset) => {
   match (value) {
-    _ when value == fromGrain(true) ||
-      value == fromGrain(false) ||
-      value == fromGrain(void) ||
-      (value & Tags._GRAIN_NUMBER_TAG_MASK) == Tags._GRAIN_NUMBER_TAG_TYPE ||
-      (value & Tags._GRAIN_GENERIC_TAG_MASK) == Tags._GRAIN_SHORTVAL_TAG_TYPE =>
+    _ when value == fromGrain(true)
+      || value == fromGrain(false)
+      || value == fromGrain(void)
+      || (value & Tags._GRAIN_NUMBER_TAG_MASK) == Tags._GRAIN_NUMBER_TAG_TYPE
+      || (value & Tags._GRAIN_GENERIC_TAG_MASK) == Tags._GRAIN_SHORTVAL_TAG_TYPE =>
       None,
     _ => reportError("Unknown value", offset),
   }
@@ -658,9 +658,9 @@ let rec validateHeap = (buf, bufSize, offset, valuesChecked) => {
               None => void,
             }
             if (
-              load(buf, numeratorOffset) != Tags._GRAIN_BOXED_NUM_HEAP_TAG &&
-              load(buf, numeratorOffset + 4n) !=
-                Tags._GRAIN_BIGINT_BOXED_NUM_TAG
+              load(buf, numeratorOffset) != Tags._GRAIN_BOXED_NUM_HEAP_TAG
+              && load(buf, numeratorOffset + 4n)
+                != Tags._GRAIN_BIGINT_BOXED_NUM_TAG
             ) {
               return reportError(
                 "Rational/Number numerator was not in the expected format",
@@ -668,9 +668,9 @@ let rec validateHeap = (buf, bufSize, offset, valuesChecked) => {
               )
             }
             if (
-              load(buf, denominatorOffset) != Tags._GRAIN_BOXED_NUM_HEAP_TAG &&
-              load(buf, denominatorOffset + 4n) !=
-                Tags._GRAIN_BIGINT_BOXED_NUM_TAG
+              load(buf, denominatorOffset) != Tags._GRAIN_BOXED_NUM_HEAP_TAG
+              && load(buf, denominatorOffset + 4n)
+                != Tags._GRAIN_BIGINT_BOXED_NUM_TAG
             ) {
               return reportError(
                 "Rational/Number denominator was not in the expected format",
@@ -682,9 +682,9 @@ let rec validateHeap = (buf, bufSize, offset, valuesChecked) => {
               None => void,
             }
             if (
-              load(buf, numeratorOffset) != Tags._GRAIN_BOXED_NUM_HEAP_TAG &&
-              load(buf, numeratorOffset + 4n) !=
-                Tags._GRAIN_BIGINT_BOXED_NUM_TAG
+              load(buf, numeratorOffset) != Tags._GRAIN_BOXED_NUM_HEAP_TAG
+              && load(buf, numeratorOffset + 4n)
+                != Tags._GRAIN_BIGINT_BOXED_NUM_TAG
             ) {
               return reportError(
                 "Rational/Number numerator was not in the expected format",
@@ -692,9 +692,9 @@ let rec validateHeap = (buf, bufSize, offset, valuesChecked) => {
               )
             }
             let denominatorError = if (
-              load(buf, denominatorOffset) != Tags._GRAIN_BOXED_NUM_HEAP_TAG &&
-              load(buf, denominatorOffset + 4n) !=
-                Tags._GRAIN_BIGINT_BOXED_NUM_TAG
+              load(buf, denominatorOffset) != Tags._GRAIN_BOXED_NUM_HEAP_TAG
+              && load(buf, denominatorOffset + 4n)
+                != Tags._GRAIN_BIGINT_BOXED_NUM_TAG
             ) {
               return reportError(
                 "Rational/Number denominator was not in the expected format",
@@ -754,12 +754,13 @@ let validate = (buf, bufSize) => {
     } else {
       // Handle non-heap values: booleans, chars, void, etc.
       match (value) {
-        _ when value == fromGrain(true) ||
-          value == fromGrain(false) ||
-          value == fromGrain(void) ||
-          (value & Tags._GRAIN_NUMBER_TAG_MASK) == Tags._GRAIN_NUMBER_TAG_TYPE ||
-          (value & Tags._GRAIN_GENERIC_TAG_MASK) ==
-            Tags._GRAIN_SHORTVAL_TAG_TYPE => None,
+        _ when value == fromGrain(true)
+          || value == fromGrain(false)
+          || value == fromGrain(void)
+          || (value & Tags._GRAIN_NUMBER_TAG_MASK)
+            == Tags._GRAIN_NUMBER_TAG_TYPE
+          || (value & Tags._GRAIN_GENERIC_TAG_MASK)
+            == Tags._GRAIN_SHORTVAL_TAG_TYPE => None,
         _ => reportError("Unknown value", 0n),
       }
     }
@@ -1006,9 +1007,9 @@ let rec unmarshalHeap = (buf, offset, valuesUnmarshaled) => {
         },
       }
     },
-    t when t == Tags._GRAIN_INT32_HEAP_TAG ||
-      t == Tags._GRAIN_FLOAT32_HEAP_TAG ||
-      t == Tags._GRAIN_UINT32_HEAP_TAG => {
+    t when t == Tags._GRAIN_INT32_HEAP_TAG
+      || t == Tags._GRAIN_FLOAT32_HEAP_TAG
+      || t == Tags._GRAIN_UINT32_HEAP_TAG => {
       let value = Memory.malloc(8n)
       Memory.copy(value, valuePtr, 8n)
 

package/marshal.md

@@ -37,7 +37,7 @@ No other changes yet.
 </details>
 
 ```grain
-marshal : (value: a) => Bytes
+marshal: (value: a) => Bytes
 ```
 
 Serialize a value into a byte-based representation suitable for transmission
@@ -74,7 +74,7 @@ No other changes yet.
 </details>
 
 ```grain
-unmarshal : (bytes: Bytes) => Result<a, String>
+unmarshal: (bytes: Bytes) => Result<a, String>
 ```
 
 Deserialize the byte-based representation of a value back into an in-memory