@grain/stdlib 0.5.2 → 0.5.4

package/runtime/numbers.md

@@ -10,6 +10,18 @@ isBoxedNumber : WasmI32 -> Bool
 isFloat : WasmI32 -> Bool
 ```
 
+### Numbers.**isInteger**
+
+```grain
+isInteger : WasmI32 -> Bool
+```
+
+### Numbers.**isRational**
+
+```grain
+isRational : WasmI32 -> Bool
+```
+
 ### Numbers.**isNumber**
 
 ```grain
@@ -94,6 +106,12 @@ coerceNumberToWasmI32 : Number -> WasmI32
 numberEqual : (WasmI32, WasmI32) -> Bool
 ```
 
+### Numbers.**cmp**
+
+```grain
+cmp : (WasmI32, WasmI32, Bool) -> WasmI32
+```
+
 ### Numbers.**(<)**
 
 ```grain
@@ -118,6 +136,12 @@ numberEqual : (WasmI32, WasmI32) -> Bool
 (>=) : (Number, Number) -> Bool
 ```
 
+### Numbers.**compare**
+
+```grain
+compare : (Number, Number) -> Number
+```
+
 ### Numbers.**numberEq**
 
 ```grain
@@ -298,3 +322,29 @@ decr : Number -> Number
 isBigInt : a -> Bool
 ```
 
+### Numbers.**scalbn**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+scalbn : (WasmF64, WasmI32) -> WasmF64
+```
+
+Multiplies a floating-point number by an integral power of 2.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`WasmF64`|The floating-point value|
+|`n`|`WasmI32`|The Integer exponent|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`WasmF64`|The result of x * 2^n|
+

package/runtime/string.gr

@@ -547,7 +547,8 @@ let rec heapValueToString = (ptr, extraIndents, toplevel) => {
       join(strings)
     },
   }
-}, toStringHelp = (grainValue, extraIndents, toplevel) => {
+},
+toStringHelp = (grainValue, extraIndents, toplevel) => {
   if ((grainValue & 1n) != 0n) {
     // Simple (unboxed) numbers
     NumberUtils.itoa32(grainValue >> 1n, 10n)
@@ -572,7 +573,8 @@ let rec heapValueToString = (ptr, extraIndents, toplevel) => {
       "<unknown value>"
     }
   }
-}, listToString = (ptr, extraIndents) => {
+},
+listToString = (ptr, extraIndents) => {
   let mut cur = ptr
   let mut isFirst = true
 

package/set.gr

@@ -2,7 +2,7 @@
  * @module Set: A Set is an unordered collection of unique values. Operations on a Set mutate the internal state, so it never needs to be re-assigned.
  * @example import Set from "set"
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 import List from "list"
 import Array from "array"
@@ -33,7 +33,7 @@ record Set<k> {
  * @param size: The initial storage size of the set
  * @returns An empty set with the given initial storage size
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let makeSized = size => {
   let buckets = Array.make(size, None)
@@ -44,7 +44,7 @@ export let makeSized = size => {
  *
  * @returns An empty set
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let make = () => {
   makeSized(16)
@@ -121,7 +121,7 @@ let rec nodeInBucket = (key, node) => {
  * @param key: The value to add
  * @param set: The set to update
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let add = (key, set) => {
   let buckets = set.buckets
@@ -154,7 +154,7 @@ export let add = (key, set) => {
  * @param set: The set to search
  * @returns `true` if the set contains the given value or `false` otherwise
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let contains = (key, set) => {
   let buckets = set.buckets
@@ -186,7 +186,7 @@ let rec removeInBucket = (key, node) => {
  * @param key: The value to remove
  * @param set: The set to update
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let remove = (key, set) => {
   let buckets = set.buckets
@@ -214,7 +214,7 @@ export let remove = (key, set) => {
  * @param set: The set to inspect
  * @returns The count of elements in the set
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let size = set => {
   set.size
@@ -226,7 +226,7 @@ export let size = set => {
  * @param set: The set to inspect
  * @returns `true` if the given set is empty or `false` otherwise
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let isEmpty = set => {
   size(set) == 0
@@ -237,7 +237,7 @@ export let isEmpty = set => {
  *
  * @param set: The set to reset
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let clear = set => {
   set.size = 0
@@ -263,7 +263,7 @@ let rec forEachBucket = (fn, node) => {
  * @param fn: The iterator function to call with each element
  * @param set: The set to iterate
  * 
- * @since 0.3.0
+ * @since v0.3.0
  * @history v0.5.0: Ensured the iterator function return type is always `Void`
  */
 export let forEach = (fn, set) => {
@@ -288,7 +288,7 @@ let rec reduceEachBucket = (fn, node, acc) => {
  * @param set: The set to iterate
  * @returns The final accumulator returned from `fn`
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let reduce = (fn, init, set) => {
   let buckets = set.buckets
@@ -305,10 +305,10 @@ export let reduce = (fn, init, set) => {
  * @param fn: The predicate function to indicate which elements to remove from the set, where returning `false` indicates the value should be removed
  * @param set: The set to iterate
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
-export let filter = (predicate, set) => {
-  let keysToRemove = reduce((list, key) => if (!predicate(key)) {
+export let filter = (fn, set) => {
+  let keysToRemove = reduce((list, key) => if (!fn(key)) {
     [key, ...list]
   } else {
     list
@@ -324,10 +324,10 @@ export let filter = (predicate, set) => {
  * @param fn: The predicate function to indicate which elements to remove from the set, where returning `true` indicates the value should be removed
  * @param set: The set to iterate
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
-export let reject = (predicate, set) => {
-  filter(key => !predicate(key), set)
+export let reject = (fn, set) => {
+  filter(key => !fn(key), set)
 }
 
 /**
@@ -336,7 +336,7 @@ export let reject = (predicate, set) => {
  * @param set: The set to convert
  * @returns A list containing all set values
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let toList = set => {
   reduce((list, key) => [key, ...list], [], set)
@@ -348,7 +348,7 @@ export let toList = set => {
  * @param list: The list to convert
  * @returns A set containing all list values
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let fromList = list => {
   let set = make()
@@ -364,7 +364,7 @@ export let fromList = list => {
  * @param set: The set to convert
  * @returns An array containing all set values
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let toArray = set => {
   Array.fromList(toList(set))
@@ -376,7 +376,7 @@ export let toArray = set => {
  * @param array: The array to convert
  * @returns A set containing all array values
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let fromArray = array => {
   let set = make()
@@ -393,7 +393,7 @@ export let fromArray = array => {
  * @param set2: The second set to combine
  * @returns A set containing all elements of both sets
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let union = (set1, set2) => {
   let set = make()
@@ -413,7 +413,7 @@ export let union = (set1, set2) => {
  * @param set2: The second set to combine
  * @returns A set containing only unshared elements from both sets
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let diff = (set1, set2) => {
   let set = make()
@@ -437,7 +437,7 @@ export let diff = (set1, set2) => {
  * @param set2: The second set to combine
  * @returns A set containing only shared elements from both sets
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let intersect = (set1, set2) => {
   let set = make()
@@ -454,15 +454,14 @@ export let intersect = (set1, set2) => {
   set
 }
 
-// TODO: Should return a Record type instead of a Tuple
-// Waiting on https://github.com/grain-lang/grain/issues/190
+// TODO(#190): Should return a Record type instead of a Tuple
 /**
  * Provides data representing the internal state state of the set.
  *
  * @param set: The set to inspect
  * @returns The internal state of the set
  * 
- * @since 0.3.0
+ * @since v0.3.0
  */
 export let getInternalStats = set => {
   (set.size, Array.length(set.buckets))

package/stack.gr

@@ -20,10 +20,22 @@ record Stack<a> {
  * @section Values: Functions and constants included in the Stack module.
  */
 
+/**
+ * An empty stack.
+ * 
+ * @since v0.5.4
+ */
+export let empty = {
+  let empty = { data: [], }
+  empty
+}
+
 /**
  * Creates a new stack.
  *
  * @returns An empty stack
+ * 
+ * @deprecated This will be removed in the v0.6.0 release of Grain.
  */
 export let make = () => {
   { data: [], }

package/stack.md

@@ -24,8 +24,23 @@ Stacks are immutable data structures that store their data in a List.
 
 Functions and constants included in the Stack module.
 
+### Stack.**empty**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+empty : Stack<a>
+```
+
+An empty stack.
+
 ### Stack.**make**
 
+> **Deprecated:** This will be removed in the v0.6.0 release of Grain.
+
 ```grain
 make : () -> Stack<a>
 ```