@grain/stdlib 0.4.5 → 0.5.1

package/float64.md

@@ -0,0 +1,315 @@
+---
+title: Float64
+---
+
+Utilities for working with the Float64 type.
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+import Float64 from "float64"
+```
+
+## Conversions
+
+Functions for converting between Numbers and the Float64 type.
+
+### Float64.**fromNumber**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+fromNumber : Number -> Float64
+```
+
+Converts a Number to a Float64.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`number`|`Number`|The value to convert|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float64`|The Number represented as a Float64|
+
+### Float64.**toNumber**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+toNumber : Float64 -> Number
+```
+
+Converts a Float64 to a Number.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`float`|`Float64`|The value to convert|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The Float64 represented as a Number|
+
+## Operations
+
+Mathematical operations for Float64 values.
+
+### Float64.**add**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+add : (Float64, Float64) -> Float64
+```
+
+Computes the sum of its operands.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float64`|The first operand|
+|`y`|`Float64`|The second operand|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float64`|The sum of the two operands|
+
+### Float64.**sub**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+sub : (Float64, Float64) -> Float64
+```
+
+Computes the difference of its operands.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float64`|The first operand|
+|`y`|`Float64`|The second operand|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float64`|The difference of the two operands|
+
+### Float64.**mul**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+mul : (Float64, Float64) -> Float64
+```
+
+Computes the product of its operands.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float64`|The first operand|
+|`y`|`Float64`|The second operand|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float64`|The product of the two operands|
+
+### Float64.**div**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+div : (Float64, Float64) -> Float64
+```
+
+Computes the quotient of its operands.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float64`|The first operand|
+|`y`|`Float64`|The second operand|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Float64`|The quotient of the two operands|
+
+## Comparisons
+
+Functions for comparing Float64 values.
+
+### Float64.**lt**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+lt : (Float64, Float64) -> Bool
+```
+
+Checks if the first value is less than the second value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float64`|The first value|
+|`y`|`Float64`|The second value|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the first value is less than the second value or `false` otherwise|
+
+### Float64.**gt**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+gt : (Float64, Float64) -> Bool
+```
+
+Checks if the first value is greater than the second value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float64`|The first value|
+|`y`|`Float64`|The second value|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the first value is greater than the second value or `false` otherwise|
+
+### Float64.**lte**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+lte : (Float64, Float64) -> Bool
+```
+
+Checks if the first value is less than or equal to the second value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float64`|The first value|
+|`y`|`Float64`|The second value|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the first value is less than or equal to the second value or `false` otherwise|
+
+### Float64.**gte**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.2.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+gte : (Float64, Float64) -> Bool
+```
+
+Checks if the first value is greater than or equal to the second value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Float64`|The first value|
+|`y`|`Float64`|The second value|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the first value is greater than or equal to the second value or `false` otherwise|
+
+## Constants
+
+Float64 constant values.
+
+### Float64.**infinity**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+infinity : Float64
+```
+
+Infinity represented as a Float64 value.
+
+### Float64.**nan**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+nan : Float64
+```
+
+NaN (Not a Number) represented as a Float64 value.
+

package/hash.gr

@@ -1,5 +1,3 @@
-/* grainc-flags --no-gc */
-
 /**
  * @module Hash: Utilities for hashing any value.
  * @example import Hash from "hash"
@@ -27,34 +25,42 @@ import WasmI32, {
   gtU as (>),
   ltU as (<),
 } from "runtime/unsafe/wasmi32"
+import WasmI64 from "runtime/unsafe/wasmi64"
 import Tags from "runtime/unsafe/tags"
-import Memory from "runtime/unsafe/memory"
 
 import { tagSimpleNumber } from "runtime/dataStructures"
 import { coerceNumberToWasmI32 } from "runtime/numbers"
+import BI from "runtime/bigint"
 
 import Random from "sys/random"
 import Result from "result"
 
+@unsafe
 let seed = {
-  Memory.incRef(WasmI32.fromGrain(Random.random))
-  Memory.incRef(WasmI32.fromGrain(Result.unwrap))
   let random = Random.random()
-  Memory.incRef(WasmI32.fromGrain(random))
   coerceNumberToWasmI32(Result.unwrap(random))
 }
 
+@unsafe
 let _MAX_HASH_DEPTH = 31n
 
+@unsafe
 let c1 = 0xcc9e2d51n
+@unsafe
 let c2 = 0x1b873593n
+@unsafe
 let r1 = 15n
+@unsafe
 let r2 = 13n
+@unsafe
 let m = 5n
+@unsafe
 let n = 0xe6546b64n
 
+@unsafe
 let mut h = seed
 
+@unsafe
 let hash32 = k => {
   let mut k = k * c1
   k = WasmI32.rotl(k, r1)
@@ -65,6 +71,14 @@ let hash32 = k => {
   h = h * m + n
 }
 
+@unsafe
+let hash64 = k => {
+  // convenience function for hashing 64-bit values
+  hash32(WasmI32.wrapI64(k))
+  hash32(WasmI32.wrapI64(WasmI64.shrU(k, 32N)))
+}
+
+@unsafe
 let hashRemaining = r => {
   // Note: wasm is little-endian so no swap is necessary
 
@@ -75,6 +89,7 @@ let hashRemaining = r => {
   h = h ^ r
 }
 
+@unsafe
 let finalize = len => {
   h = h ^ len
 
@@ -85,6 +100,7 @@ let finalize = len => {
   h = h ^ h >>> 16n
 }
 
+@unsafe
 let rec hashOne = (val, depth) => {
   if (depth > _MAX_HASH_DEPTH) {
     void
@@ -112,22 +128,6 @@ let rec hashOne = (val, depth) => {
         if (rem != 0n) hashRemaining(rem)
         finalize(length)
       },
-      t when t == Tags._GRAIN_CHAR_HEAP_TAG => {
-        let word = WasmI32.load(heapPtr, 4n)
-        // little-endian byte order
-        let byte = word & 0xFFn
-        let mut shift = 0n
-        if ((byte & 0x80n) == 0x00n) {
-          shift = 24n
-        } else if ((byte & 0xF0n) == 0xF0n) {
-          shift = 0n
-        } else if ((byte & 0xE0n) == 0xE0n) {
-          shift = 8n
-        } else {
-          shift = 16n
-        }
-        hash32(word << shift)
-      },
       t when t == Tags._GRAIN_ADT_HEAP_TAG => {
         // moduleId
         hash32(WasmI32.load(heapPtr, 4n))
@@ -189,6 +189,15 @@ let rec hashOne = (val, depth) => {
             hash32(WasmI32.load(heapPtr, 8n))
             hash32(WasmI32.load(heapPtr, 12n))
           },
+          t when t == Tags._GRAIN_BIGINT_BOXED_NUM_TAG => {
+            // TODO(#1187): should include fixint size once implemented
+            let size = BI.getSize(heapPtr)
+            hash32(size)
+            hash32(BI.getFlags(heapPtr))
+            for (let mut i = 0n; i < size; i += 1n) {
+              hash64(BI.getLimb(heapPtr, i))
+            }
+          },
           t when t == Tags._GRAIN_FLOAT32_BOXED_NUM_TAG => {
             hash32(WasmI32.load(heapPtr, 8n))
           },
@@ -197,8 +206,8 @@ let rec hashOne = (val, depth) => {
             hash32(WasmI32.load(heapPtr, 12n))
           },
           t when t == Tags._GRAIN_RATIONAL_BOXED_NUM_TAG => {
-            hash32(WasmI32.load(heapPtr, 8n))
-            hash32(WasmI32.load(heapPtr, 12n))
+            hashOne(WasmI32.load(heapPtr, 8n), depth + 1n)
+            hashOne(WasmI32.load(heapPtr, 12n), depth + 1n)
           },
           _ => {
             hash32(heapPtr)
@@ -209,13 +218,8 @@ let rec hashOne = (val, depth) => {
         hash32(heapPtr)
       },
     }
-  } else if (val == WasmI32.fromGrain(true)) {
-    hash32(val)
-  } else if (val == WasmI32.fromGrain(false)) {
-    hash32(val)
-  } else if (val == WasmI32.fromGrain(void)) {
-    hash32(val)
   } else {
+    // Handle non-heap values: booleans, chars, void, etc.
     hash32(val)
   }
 }
@@ -231,7 +235,8 @@ let rec hashOne = (val, depth) => {
  *
  * @since v0.1.0
  */
-export let rec hash = anything => {
+@unsafe
+export let hash = anything => {
   h = seed
 
   hashOne(WasmI32.fromGrain(anything), 0n)
@@ -239,10 +244,5 @@ export let rec hash = anything => {
 
   // Tag the number on the way out.
   // Since Grain has proper modulus, negative numbers are okay.
-  let result = tagSimpleNumber(h)
-
-  Memory.decRef(WasmI32.fromGrain(hash))
-  Memory.decRef(WasmI32.fromGrain(anything))
-
-  result
+  tagSimpleNumber(h)
 }