@grain/stdlib 0.5.3 → 0.5.5

package/int32.gr

@@ -1,7 +1,7 @@
 /**
  * @module Int32: Utilities for working with the Int32 type.
  * @example import Int32 from "int32"
- * 
+ *
  * @since v0.2.0
  */
 import WasmI32 from "runtime/unsafe/wasmi32"
@@ -23,7 +23,7 @@ import {
  *
  * @param number: The value to convert
  * @returns The Number represented as an Int32
- * 
+ *
  * @since v0.2.0
  */
 export fromNumber
@@ -33,7 +33,7 @@ export fromNumber
  *
  * @param value: The value to convert
  * @returns The Int32 represented as a Number
- * 
+ *
  * @since v0.2.0
  */
 export toNumber
@@ -47,7 +47,7 @@ export toNumber
  *
  * @param value: The value to increment
  * @returns The incremented value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -62,7 +62,7 @@ export let incr = (value: Int32) => {
  *
  * @param value: The value to decrement
  * @returns The decremented value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -78,7 +78,7 @@ export let decr = (value: Int32) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The sum of the two operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -95,7 +95,7 @@ export let add = (x: Int32, y: Int32) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The difference of the two operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -112,7 +112,7 @@ export let sub = (x: Int32, y: Int32) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The product of the two operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -129,7 +129,7 @@ export let mul = (x: Int32, y: Int32) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The quotient of its operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -146,7 +146,7 @@ export let div = (x: Int32, y: Int32) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The quotient of its operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -163,7 +163,7 @@ export let divU = (x: Int32, y: Int32) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The remainder of its operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -180,7 +180,7 @@ export let rem = (x: Int32, y: Int32) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The remainder of its operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -198,13 +198,15 @@ let abs = n => {
 }
 
 /**
- * Computes the remainder of the division of the first operand by the second. 
+ * Computes the remainder of the division of the first operand by the second.
  * The result will have the sign of the second operand.
  *
  * @param x: The first operand
  * @param y: The second operand
  * @returns The modulus of its operands
- * 
+ *
+ * @throws ModuloByZero: When `y` is zero
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -242,7 +244,7 @@ export let mod = (x: Int32, y: Int32) => {
  * @param value: The value to rotate
  * @param amount: The number of bits to rotate by
  * @returns The rotated value
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -259,7 +261,7 @@ export let rotl = (value: Int32, amount: Int32) => {
  * @param value: The value to rotate
  * @param amount: The number of bits to rotate by
  * @returns The rotated value
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -276,7 +278,7 @@ export let rotr = (value: Int32, amount: Int32) => {
  * @param value: The value to shift
  * @param amount: The number of bits to shift by
  * @returns The shifted value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -293,7 +295,7 @@ export let shl = (value: Int32, amount: Int32) => {
  * @param value: The value to shift
  * @param amount: The amount to shift by
  * @returns The shifted value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -310,7 +312,7 @@ export let shr = (value: Int32, amount: Int32) => {
  * @param value: The value to shift
  * @param amount: The amount to shift by
  * @returns The shifted value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -331,7 +333,7 @@ export let shrU = (value: Int32, amount: Int32) => {
  * @param x: The first value
  * @param y: The second value
  * @returns `true` if the first value is equal to the second value or `false` otherwise
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -347,7 +349,7 @@ export let eq = (x: Int32, y: Int32) => {
  * @param x: The first value
  * @param y: The second value
  * @returns `true` if the first value is not equal to the second value or `false` otherwise
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -362,7 +364,7 @@ export let ne = (x: Int32, y: Int32) => {
  *
  * @param value: The value to inspect
  * @returns `true` if the first value is equal to zero or `false` otherwise
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -377,7 +379,7 @@ export let eqz = (value: Int32) => {
  * @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
  */
 @unsafe
@@ -397,7 +399,7 @@ export let lt = (x: Int32, y: Int32) => {
  * @since v0.5.0
  */
 @unsafe
-export let rec ltU = (x: Int32, y: Int32) => {
+export let ltU = (x: Int32, y: Int32) => {
   let xv = WasmI32.load(WasmI32.fromGrain(x), 8n)
   let yv = WasmI32.load(WasmI32.fromGrain(y), 8n)
   WasmI32.ltU(xv, yv)
@@ -409,7 +411,7 @@ export let rec ltU = (x: Int32, y: Int32) => {
  * @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
  */
 @unsafe
@@ -429,7 +431,7 @@ export let gt = (x: Int32, y: Int32) => {
  * @since v0.5.0
  */
 @unsafe
-export let rec gtU = (x: Int32, y: Int32) => {
+export let gtU = (x: Int32, y: Int32) => {
   let xv = WasmI32.load(WasmI32.fromGrain(x), 8n)
   let yv = WasmI32.load(WasmI32.fromGrain(y), 8n)
   WasmI32.gtU(xv, yv)
@@ -441,7 +443,7 @@ export let rec gtU = (x: Int32, y: Int32) => {
  * @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
  */
 @unsafe
@@ -461,7 +463,7 @@ export let lte = (x: Int32, y: Int32) => {
  * @since v0.5.0
  */
 @unsafe
-export let rec lteU = (x: Int32, y: Int32) => {
+export let lteU = (x: Int32, y: Int32) => {
   let xv = WasmI32.load(WasmI32.fromGrain(x), 8n)
   let yv = WasmI32.load(WasmI32.fromGrain(y), 8n)
   WasmI32.leU(xv, yv)
@@ -473,7 +475,7 @@ export let rec lteU = (x: Int32, y: Int32) => {
  * @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
  */
 @unsafe
@@ -493,7 +495,7 @@ export let gte = (x: Int32, y: Int32) => {
  * @since v0.5.0
  */
 @unsafe
-export let rec gteU = (x: Int32, y: Int32) => {
+export let gteU = (x: Int32, y: Int32) => {
   let xv = WasmI32.load(WasmI32.fromGrain(x), 8n)
   let yv = WasmI32.load(WasmI32.fromGrain(y), 8n)
   WasmI32.geU(xv, yv)
@@ -508,7 +510,7 @@ export let rec gteU = (x: Int32, y: Int32) => {
  *
  * @param value: The given value
  * @returns Containing the inverted bits of the given value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -524,7 +526,7 @@ export let lnot = (value: Int32) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns Containing a `1` in each bit position for which the corresponding bits of both operands are `1`
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -541,7 +543,7 @@ export let land = (x: Int32, y: Int32) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns Containing a `1` in each bit position for which the corresponding bits of either or both operands are `1`
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -558,7 +560,7 @@ export let lor = (x: Int32, y: Int32) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns Containing a `1` in each bit position for which the corresponding bits of either but not both operands are `1`
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -574,7 +576,7 @@ export let lxor = (x: Int32, y: Int32) => {
  *
  * @param value: The value to inspect
  * @returns The amount of leading zeros
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -589,7 +591,7 @@ export let clz = (value: Int32) => {
  *
  * @param value: The value to inspect
  * @returns The amount of trailing zeros
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -604,7 +606,7 @@ export let ctz = (value: Int32) => {
  *
  * @param value: The value to inspect
  * @returns The amount of 1-bits in its operand
- * 
+ *
  * @since v0.4.0
  */
 @unsafe

package/int32.md

@@ -330,6 +330,12 @@ Returns:
 |----|-----------|
 |`Int32`|The modulus of its operands|
 
+Throws:
+
+`ModuloByZero`
+
+* When `y` is zero
+
 ## Bitwise operations
 
 Functions for operating on bits of Int32 values.

package/int64.gr

@@ -1,7 +1,7 @@
 /**
  * @module Int64: Utilities for working with the Int64 type.
  * @example import Int64 from "int64"
- * 
+ *
  * @since v0.2.0
  */
 import WasmI32 from "runtime/unsafe/wasmi32"
@@ -24,7 +24,7 @@ import {
  *
  * @param number: The value to convert
  * @returns The Number represented as an Int64
- * 
+ *
  * @since v0.2.0
  */
 export fromNumber
@@ -34,7 +34,7 @@ export fromNumber
  *
  * @param value: The value to convert
  * @returns The Int64 represented as a Number
- * 
+ *
  * @since v0.2.0
  */
 export toNumber
@@ -48,7 +48,7 @@ export toNumber
  *
  * @param value: The value to increment
  * @returns The incremented value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -63,7 +63,7 @@ export let incr = (value: Int64) => {
  *
  * @param value: The value to decrement
  * @returns The decremented value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -79,7 +79,7 @@ export let decr = (value: Int64) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The sum of the two operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -96,7 +96,7 @@ export let add = (x: Int64, y: Int64) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The difference of the two operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -113,7 +113,7 @@ export let sub = (x: Int64, y: Int64) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The product of the two operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -130,7 +130,7 @@ export let mul = (x: Int64, y: Int64) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The quotient of its operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -147,7 +147,7 @@ export let div = (x: Int64, y: Int64) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The quotient of its operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -164,7 +164,7 @@ export let divU = (x: Int64, y: Int64) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The remainder of its operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -181,7 +181,7 @@ export let rem = (x: Int64, y: Int64) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns The remainder of its operands
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -199,13 +199,15 @@ let abs = n => {
 }
 
 /**
- * Computes the remainder of the division of the first operand by the second. 
+ * Computes the remainder of the division of the first operand by the second.
  * The result will have the sign of the second operand.
  *
  * @param x: The first operand
  * @param y: The second operand
  * @returns The modulus of its operands
- * 
+ *
+ * @throws ModuloByZero: When `y` is zero
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -243,7 +245,7 @@ export let mod = (x: Int64, y: Int64) => {
  * @param value: The value to rotate
  * @param amount: The number of bits to rotate by
  * @returns The rotated value
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -260,7 +262,7 @@ export let rotl = (value: Int64, amount: Int64) => {
  * @param value: The value to rotate
  * @param amount: The number of bits to rotate by
  * @returns The rotated value
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -277,7 +279,7 @@ export let rotr = (value: Int64, amount: Int64) => {
  * @param value: The value to shift
  * @param amount: The number of bits to shift by
  * @returns The shifted value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -294,7 +296,7 @@ export let shl = (value: Int64, amount: Int64) => {
  * @param value: The value to shift
  * @param amount: The amount to shift by
  * @returns The shifted value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -311,7 +313,7 @@ export let shr = (value: Int64, amount: Int64) => {
  * @param value: The value to shift
  * @param amount: The amount to shift by
  * @returns The shifted value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -332,7 +334,7 @@ export let shrU = (value: Int64, amount: Int64) => {
  * @param x: The first value
  * @param y: The second value
  * @returns `true` if the first value is equal to the second value or `false` otherwise
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -348,7 +350,7 @@ export let eq = (x: Int64, y: Int64) => {
  * @param x: The first value
  * @param y: The second value
  * @returns `true` if the first value is not equal to the second value or `false` otherwise
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -363,7 +365,7 @@ export let ne = (x: Int64, y: Int64) => {
  *
  * @param value: The value to inspect
  * @returns `true` if the first value is equal to zero or `false` otherwise
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -378,7 +380,7 @@ export let eqz = (value: Int64) => {
  * @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
  */
 @unsafe
@@ -398,7 +400,7 @@ export let lt = (x: Int64, y: Int64) => {
  * @since v0.5.0
  */
 @unsafe
-export let rec ltU = (x: Int64, y: Int64) => {
+export let ltU = (x: Int64, y: Int64) => {
   let xv = WasmI64.load(WasmI32.fromGrain(x), 8n)
   let yv = WasmI64.load(WasmI32.fromGrain(y), 8n)
   WasmI64.ltU(xv, yv)
@@ -410,7 +412,7 @@ export let rec ltU = (x: Int64, y: Int64) => {
  * @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
  */
 @unsafe
@@ -430,7 +432,7 @@ export let gt = (x: Int64, y: Int64) => {
  * @since v0.5.0
  */
 @unsafe
-export let rec gtU = (x: Int64, y: Int64) => {
+export let gtU = (x: Int64, y: Int64) => {
   let xv = WasmI64.load(WasmI32.fromGrain(x), 8n)
   let yv = WasmI64.load(WasmI32.fromGrain(y), 8n)
   WasmI64.gtU(xv, yv)
@@ -442,7 +444,7 @@ export let rec gtU = (x: Int64, y: Int64) => {
  * @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
  */
 @unsafe
@@ -462,7 +464,7 @@ export let lte = (x: Int64, y: Int64) => {
  * @since v0.5.0
  */
 @unsafe
-export let rec lteU = (x: Int64, y: Int64) => {
+export let lteU = (x: Int64, y: Int64) => {
   let xv = WasmI64.load(WasmI32.fromGrain(x), 8n)
   let yv = WasmI64.load(WasmI32.fromGrain(y), 8n)
   WasmI64.leU(xv, yv)
@@ -474,7 +476,7 @@ export let rec lteU = (x: Int64, y: Int64) => {
  * @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
  */
 @unsafe
@@ -494,7 +496,7 @@ export let gte = (x: Int64, y: Int64) => {
  * @since v0.5.0
  */
 @unsafe
-export let rec gteU = (x: Int64, y: Int64) => {
+export let gteU = (x: Int64, y: Int64) => {
   let xv = WasmI64.load(WasmI32.fromGrain(x), 8n)
   let yv = WasmI64.load(WasmI32.fromGrain(y), 8n)
   WasmI64.geU(xv, yv)
@@ -509,7 +511,7 @@ export let rec gteU = (x: Int64, y: Int64) => {
  *
  * @param value: The given value
  * @returns Containing the inverted bits of the given value
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -525,7 +527,7 @@ export let lnot = (value: Int64) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns Containing a `1` in each bit position for which the corresponding bits of both operands are `1`
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -542,7 +544,7 @@ export let land = (x: Int64, y: Int64) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns Containing a `1` in each bit position for which the corresponding bits of either or both operands are `1`
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -559,7 +561,7 @@ export let lor = (x: Int64, y: Int64) => {
  * @param x: The first operand
  * @param y: The second operand
  * @returns Containing a `1` in each bit position for which the corresponding bits of either but not both operands are `1`
- * 
+ *
  * @since v0.2.0
  */
 @unsafe
@@ -575,7 +577,7 @@ export let lxor = (x: Int64, y: Int64) => {
  *
  * @param value: The value to inspect
  * @returns The amount of leading zeros
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -590,7 +592,7 @@ export let clz = (value: Int64) => {
  *
  * @param value: The value to inspect
  * @returns The amount of trailing zeros
- * 
+ *
  * @since v0.4.0
  */
 @unsafe
@@ -605,7 +607,7 @@ export let ctz = (value: Int64) => {
  *
  * @param value: The value to inspect
  * @returns The amount of 1-bits in its operand
- * 
+ *
  * @since v0.4.0
  */
 @unsafe

package/int64.md

@@ -330,6 +330,12 @@ Returns:
 |----|-----------|
 |`Int64`|The modulus of its operands|
 
+Throws:
+
+`ModuloByZero`
+
+* When `y` is zero
+
 ## Bitwise operations
 
 Functions for operating on bits of Int64 values.