@grain/stdlib 0.4.2 → 0.4.6

package/float32.md

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

package/float64.gr

@@ -1,3 +1,9 @@
+/**
+ * @module Float64: Utilities for working with the Float64 type.
+ * @example import Float64 from "float64"
+ * 
+ * @since v0.2.0
+ */
 import WasmI32 from "runtime/unsafe/wasmi32"
 import WasmF64 from "runtime/unsafe/wasmf64"
 import Memory from "runtime/unsafe/memory"
@@ -10,10 +16,43 @@ import {
   coerceFloat64ToNumber as toNumber
 } from "runtime/numbers"
 
+/**
+ * @section Conversions: Functions for converting between Numbers and the Float64 type.
+ */
+
+/**
+ * Converts a Number to a Float64.
+ *
+ * @param number: The value to convert
+ * @returns The Number represented as a Float64
+ * 
+ * @since v0.2.0
+ */
 export fromNumber
-export toNumber
 
+/**
+ * Converts a Float64 to a Number.
+ *
+ * @param float: The value to convert
+ * @returns The Float64 represented as a Number
+ * 
+ * @since v0.2.0
+ */
+export toNumber
 
+/**
+ * @section Operations: Mathematical operations for Float64 values.
+ */
+
+/**
+ * Computes the sum of its operands.
+ *
+ * @param x: The first operand
+ * @param y: The second operand
+ * @returns The sum of the two operands
+ * 
+ * @since v0.2.0
+ */
 @disableGC
 export let rec add = (x: Float64, y: Float64) => {
   let xv = WasmF64.load(WasmI32.fromGrain(x), 8n)
@@ -26,6 +65,15 @@ export let rec add = (x: Float64, y: Float64) => {
   ret
 }
 
+/**
+ * Computes the difference of its operands.
+ *
+ * @param x: The first operand
+ * @param y: The second operand
+ * @returns The difference of the two operands
+ * 
+ * @since v0.2.0
+ */
 @disableGC
 export let rec sub = (x: Float64, y: Float64) => {
   let xv = WasmF64.load(WasmI32.fromGrain(x), 8n)
@@ -38,6 +86,15 @@ export let rec sub = (x: Float64, y: Float64) => {
   ret
 }
 
+/**
+ * Computes the product of its operands.
+ *
+ * @param x: The first operand
+ * @param y: The second operand
+ * @returns The product of the two operands
+ * 
+ * @since v0.2.0
+ */
 @disableGC
 export let rec mul = (x: Float64, y: Float64) => {
   let xv = WasmF64.load(WasmI32.fromGrain(x), 8n)
@@ -50,6 +107,15 @@ export let rec mul = (x: Float64, y: Float64) => {
   ret
 }
 
+/**
+ * Computes the quotient of its operands.
+ *
+ * @param x: The first operand
+ * @param y: The second operand
+ * @returns The quotient of the two operands
+ * 
+ * @since v0.2.0
+ */
 @disableGC
 export let rec div = (x: Float64, y: Float64) => {
   let xv = WasmF64.load(WasmI32.fromGrain(x), 8n)
@@ -62,8 +128,19 @@ export let rec div = (x: Float64, y: Float64) => {
   ret
 }
 
-
-// Float64 comparisons
+/**
+ * @section Comparisons: Functions for comparing Float64 values.
+ */
+
+/**
+ * Checks if the first value is less than the second value.
+ *
+ * @param x: The first value
+ * @param y: The second value
+ * @returns `true` if the first value is less than the second value or `false` otherwise
+ * 
+ * @since v0.2.0
+ */
 @disableGC
 export let rec lt = (x: Float64, y: Float64) => {
   let xv = WasmF64.load(WasmI32.fromGrain(x), 8n)
@@ -75,6 +152,15 @@ export let rec lt = (x: Float64, y: Float64) => {
   ret
 }
 
+/**
+ * Checks if the first value is greater than the second value.
+ *
+ * @param x: The first value
+ * @param y: The second value
+ * @returns `true` if the first value is greater than the second value or `false` otherwise
+ * 
+ * @since v0.2.0
+ */
 @disableGC
 export let rec gt = (x: Float64, y: Float64) => {
   let xv = WasmF64.load(WasmI32.fromGrain(x), 8n)
@@ -86,6 +172,15 @@ export let rec gt = (x: Float64, y: Float64) => {
   ret
 }
 
+/**
+ * Checks if the first value is less than or equal to the second value.
+ *
+ * @param x: The first value
+ * @param y: The second value
+ * @returns `true` if the first value is less than or equal to the second value or `false` otherwise
+ * 
+ * @since v0.2.0
+ */
 @disableGC
 export let rec lte = (x: Float64, y: Float64) => {
   let xv = WasmF64.load(WasmI32.fromGrain(x), 8n)
@@ -97,6 +192,15 @@ export let rec lte = (x: Float64, y: Float64) => {
   ret
 }
 
+/**
+ * Checks if the first value is greater than or equal to the second value.
+ *
+ * @param x: The first value
+ * @param y: The second value
+ * @returns `true` if the first value is greater than or equal to the second value or `false` otherwise
+ * 
+ * @since v0.2.0
+ */
 @disableGC
 export let rec gte = (x: Float64, y: Float64) => {
   let xv = WasmF64.load(WasmI32.fromGrain(x), 8n)
@@ -108,7 +212,9 @@ export let rec gte = (x: Float64, y: Float64) => {
   ret
 }
 
-// floating-point constants:
+/**
+ * @section Constants: Float64 constant values.
+ */
 
 @disableGC
 let rec makeInfinity = () => {
@@ -118,6 +224,11 @@ let rec makeInfinity = () => {
   ret
 }
 
+/**
+ * Infinity represented as a Float64 value.
+ * 
+ * @since v0.4.0
+ */
 export let infinity = makeInfinity()
 
 @disableGC
@@ -128,4 +239,9 @@ let rec makeNaN = () => {
   ret
 }
 
+/**
+ * NaN (Not a Number) represented as a Float64 value.
+ * 
+ * @since v0.4.0
+ */
 export let nan = makeNaN()