@grain/stdlib 0.6.5 → 0.7.0

package/uint16.md

@@ -13,6 +13,14 @@ No other changes yet.
 from "uint16" include Uint16
 ```
 
+```grain
+1uS
+```
+
+```grain
+10uS
+```
+
 ## Values
 
 Functions and constants included in the Uint16 module.
@@ -25,7 +33,7 @@ No other changes yet.
 </details>
 
 ```grain
-fromNumber : (number: Number) => Uint16
+fromNumber: (number: Number) => Uint16
 ```
 
 Converts a Number to a Uint16.
@@ -50,7 +58,7 @@ No other changes yet.
 </details>
 
 ```grain
-toNumber : (value: Uint16) => Number
+toNumber: (value: Uint16) => Number
 ```
 
 Converts a Uint16 to a Number.
@@ -75,7 +83,7 @@ No other changes yet.
 </details>
 
 ```grain
-fromInt16 : (number: Int16) => Uint16
+fromInt16: (number: Int16) => Uint16
 ```
 
 Converts an Int16 to a Uint16.
@@ -92,6 +100,16 @@ Returns:
 |----|-----------|
 |`Uint16`|The Int16 represented as a Uint16|
 
+Examples:
+
+```grain
+Uint16.fromInt16(1uS) == 1uS
+```
+
+```grain
+Uint16.fromInt16(-1uS) == 65535uS
+```
+
 ### Uint16.**incr**
 
 <details disabled>
@@ -100,7 +118,7 @@ No other changes yet.
 </details>
 
 ```grain
-incr : (value: Uint16) => Uint16
+incr: (value: Uint16) => Uint16
 ```
 
 Increments the value by one.
@@ -117,6 +135,12 @@ Returns:
 |----|-----------|
 |`Uint16`|The incremented value|
 
+Examples:
+
+```grain
+Uint16.incr(1uS) == 2uS
+```
+
 ### Uint16.**decr**
 
 <details disabled>
@@ -125,7 +149,7 @@ No other changes yet.
 </details>
 
 ```grain
-decr : (value: Uint16) => Uint16
+decr: (value: Uint16) => Uint16
 ```
 
 Decrements the value by one.
@@ -142,6 +166,16 @@ Returns:
 |----|-----------|
 |`Uint16`|The decremented value|
 
+Examples:
+
+```grain
+Uint16.decr(1uS) == 0uS
+```
+
+```grain
+Uint16.decr(0uS) == 65535uS
+```
+
 ### Uint16.**(+)**
 
 <details disabled>
@@ -150,7 +184,7 @@ No other changes yet.
 </details>
 
 ```grain
-(+) : (x: Uint16, y: Uint16) => Uint16
+(+): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the sum of its operands.
@@ -168,6 +202,13 @@ Returns:
 |----|-----------|
 |`Uint16`|The sum of the two operands|
 
+Examples:
+
+```grain
+use Uint16.{ (+) }
+assert 1uS + 1uS == 2uS
+```
+
 ### Uint16.**(-)**
 
 <details disabled>
@@ -176,7 +217,7 @@ No other changes yet.
 </details>
 
 ```grain
-(-) : (x: Uint16, y: Uint16) => Uint16
+(-): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the difference of its operands.
@@ -194,6 +235,13 @@ Returns:
 |----|-----------|
 |`Uint16`|The difference of the two operands|
 
+Examples:
+
+```grain
+use Uint16.{ (-) }
+assert 2uS - 1uS == 1uS
+```
+
 ### Uint16.**(*)**
 
 <details disabled>
@@ -202,7 +250,7 @@ No other changes yet.
 </details>
 
 ```grain
-(*) : (x: Uint16, y: Uint16) => Uint16
+(*): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the product of its operands.
@@ -220,6 +268,13 @@ Returns:
 |----|-----------|
 |`Uint16`|The product of the two operands|
 
+Examples:
+
+```grain
+use Uint16.{ (*) }
+assert 2uS * 2uS == 4uS
+```
+
 ### Uint16.**(/)**
 
 <details disabled>
@@ -228,7 +283,7 @@ No other changes yet.
 </details>
 
 ```grain
-(/) : (x: Uint16, y: Uint16) => Uint16
+(/): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the quotient of its operands.
@@ -246,6 +301,13 @@ Returns:
 |----|-----------|
 |`Uint16`|The quotient of its operands|
 
+Examples:
+
+```grain
+use Uint16.{ (/) }
+assert 5uS / 2uS == 2uS
+```
+
 ### Uint16.**rem**
 
 <details disabled>
@@ -254,7 +316,7 @@ No other changes yet.
 </details>
 
 ```grain
-rem : (x: Uint16, y: Uint16) => Uint16
+rem: (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the remainder of the division of its operands.
@@ -272,6 +334,12 @@ Returns:
 |----|-----------|
 |`Uint16`|The remainder of its operands|
 
+Examples:
+
+```grain
+Uint16.rem(5uS, 2uS) == 1uS
+```
+
 ### Uint16.**(<<)**
 
 <details disabled>
@@ -280,7 +348,7 @@ No other changes yet.
 </details>
 
 ```grain
-(<<) : (value: Uint16, amount: Uint16) => Uint16
+(<<): (value: Uint16, amount: Uint16) => Uint16
 ```
 
 Shifts the bits of the value left by the given number of bits.
@@ -298,6 +366,13 @@ Returns:
 |----|-----------|
 |`Uint16`|The shifted value|
 
+Examples:
+
+```grain
+use Uint16.{ (<<) }
+assert (5uS << 1uS) == 10uS
+```
+
 ### Uint16.**(>>>)**
 
 <details disabled>
@@ -306,7 +381,7 @@ No other changes yet.
 </details>
 
 ```grain
-(>>>) : (value: Uint16, amount: Uint16) => Uint16
+(>>>): (value: Uint16, amount: Uint16) => Uint16
 ```
 
 Shifts the bits of the value right by the given number of bits.
@@ -324,6 +399,13 @@ Returns:
 |----|-----------|
 |`Uint16`|The shifted value|
 
+Examples:
+
+```grain
+use Uint16.{ (>>>) }
+assert (5uS >>> 1uS) == 2uS
+```
+
 ### Uint16.**(==)**
 
 <details disabled>
@@ -332,7 +414,7 @@ No other changes yet.
 </details>
 
 ```grain
-(==) : (x: Uint16, y: Uint16) => Bool
+(==): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is equal to the second value.
@@ -350,6 +432,13 @@ Returns:
 |----|-----------|
 |`Bool`|`true` if the first value is equal to the second value or `false` otherwise|
 
+Examples:
+
+```grain
+use Uint16.{ (==) }
+assert 1uS == 1uS
+```
+
 ### Uint16.**(!=)**
 
 <details disabled>
@@ -358,7 +447,7 @@ No other changes yet.
 </details>
 
 ```grain
-(!=) : (x: Uint16, y: Uint16) => Bool
+(!=): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is not equal to the second value.
@@ -376,6 +465,13 @@ Returns:
 |----|-----------|
 |`Bool`|`true` if the first value is not equal to the second value or `false` otherwise|
 
+Examples:
+
+```grain
+use Uint16.{ (!=) }
+assert 1uS != 3uS
+```
+
 ### Uint16.**(<)**
 
 <details disabled>
@@ -384,7 +480,7 @@ No other changes yet.
 </details>
 
 ```grain
-(<) : (x: Uint16, y: Uint16) => Bool
+(<): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is less than the second value.
@@ -402,6 +498,13 @@ Returns:
 |----|-----------|
 |`Bool`|`true` if the first value is less than the second value or `false` otherwise|
 
+Examples:
+
+```grain
+use Uint16.{ (<) }
+assert 1uS < 5uS
+```
+
 ### Uint16.**(>)**
 
 <details disabled>
@@ -410,7 +513,7 @@ No other changes yet.
 </details>
 
 ```grain
-(>) : (x: Uint16, y: Uint16) => Bool
+(>): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is greater than the second value.
@@ -428,6 +531,13 @@ Returns:
 |----|-----------|
 |`Bool`|`true` if the first value is greater than the second value or `false` otherwise|
 
+Examples:
+
+```grain
+use Uint16.{ (>) }
+assert 4uS > 2uS
+```
+
 ### Uint16.**(<=)**
 
 <details disabled>
@@ -436,7 +546,7 @@ No other changes yet.
 </details>
 
 ```grain
-(<=) : (x: Uint16, y: Uint16) => Bool
+(<=): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is less than or equal to the second value.
@@ -454,6 +564,18 @@ Returns:
 |----|-----------|
 |`Bool`|`true` if the first value is less than or equal to the second value or `false` otherwise|
 
+Examples:
+
+```grain
+use Uint16.{ (<=) }
+assert 1uS <= 2uS
+```
+
+```grain
+use Uint16.{ (<=) }
+assert 1uS <= 1uS
+```
+
 ### Uint16.**(>=)**
 
 <details disabled>
@@ -462,7 +584,7 @@ No other changes yet.
 </details>
 
 ```grain
-(>=) : (x: Uint16, y: Uint16) => Bool
+(>=): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is greater than or equal to the second value.
@@ -480,6 +602,18 @@ Returns:
 |----|-----------|
 |`Bool`|`true` if the first value is greater than or equal to the second value or `false` otherwise|
 
+Examples:
+
+```grain
+use Uint16.{ (>=) }
+assert 3uS >= 2uS
+```
+
+```grain
+use Uint16.{ (>=) }
+assert 1uS >= 1uS
+```
+
 ### Uint16.**lnot**
 
 <details disabled>
@@ -488,7 +622,7 @@ No other changes yet.
 </details>
 
 ```grain
-lnot : (value: Uint16) => Uint16
+lnot: (value: Uint16) => Uint16
 ```
 
 Computes the bitwise NOT of the given value.
@@ -505,6 +639,12 @@ Returns:
 |----|-----------|
 |`Uint16`|Containing the inverted bits of the given value|
 
+Examples:
+
+```grain
+Uint16.lnot(5uS) == 65530uS
+```
+
 ### Uint16.**(&)**
 
 <details disabled>
@@ -513,7 +653,7 @@ No other changes yet.
 </details>
 
 ```grain
-(&) : (x: Uint16, y: Uint16) => Uint16
+(&): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the bitwise AND (`&`) on the given operands.
@@ -531,6 +671,13 @@ Returns:
 |----|-----------|
 |`Uint16`|Containing a `1` in each bit position for which the corresponding bits of both operands are `1`|
 
+Examples:
+
+```grain
+use Uint16.{ (&) }
+assert (3uS & 4uS) == 0uS
+```
+
 ### Uint16.**(|)**
 
 <details disabled>
@@ -539,7 +686,7 @@ No other changes yet.
 </details>
 
 ```grain
-(|) : (x: Uint16, y: Uint16) => Uint16
+(|): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the bitwise OR (`|`) on the given operands.
@@ -557,6 +704,13 @@ Returns:
 |----|-----------|
 |`Uint16`|Containing a `1` in each bit position for which the corresponding bits of either or both operands are `1`|
 
+Examples:
+
+```grain
+use Uint16.{ (|) }
+assert (3uS | 4uS) == 7uS
+```
+
 ### Uint16.**(^)**
 
 <details disabled>
@@ -565,7 +719,7 @@ No other changes yet.
 </details>
 
 ```grain
-(^) : (x: Uint16, y: Uint16) => Uint16
+(^): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the bitwise XOR (`^`) on the given operands.
@@ -583,3 +737,10 @@ Returns:
 |----|-----------|
 |`Uint16`|Containing a `1` in each bit position for which the corresponding bits of either but not both operands are `1`|
 
+Examples:
+
+```grain
+use Uint16.{ (^) }
+assert (3uS ^ 5uS) == 6uS
+```
+

package/uint32.gr

@@ -6,6 +6,12 @@
  */
 module Uint32
 
+from "runtime/unsafe/offsets" include Offsets
+use Offsets.{
+  _UINT32_VALUE_OFFSET as _VALUE_OFFSET,
+  _INT32_VALUE_OFFSET,
+  _FLOAT32_VALUE_OFFSET,
+}
 from "runtime/unsafe/wasmi32" include WasmI32
 use WasmI32.{ (+), (-), (*), (&), (|), (^), (<<), (>>>), (==), (!=) }
 from "runtime/unsafe/wasmi64" include WasmI64
@@ -16,9 +22,6 @@ use Numbers.{ reducedUnsignedInteger, coerceNumberToUnsignedWasmI32 }
 from "runtime/dataStructures" include DataStructures
 use DataStructures.{ newUint32 }
 
-@unsafe
-let _VALUE_OFFSET = 4n
-
 /**
  * Converts a Number to a Uint32.
  *
@@ -60,7 +63,25 @@ provide let toNumber = (value: Uint32) => {
  */
 @unsafe
 provide let fromInt32 = (number: Int32) => {
-  let x = WasmI32.load(WasmI32.fromGrain(number), _VALUE_OFFSET)
+  let x = WasmI32.load(WasmI32.fromGrain(number), _INT32_VALUE_OFFSET)
+  let result = newUint32(x)
+  WasmI32.toGrain(result): Uint32
+}
+
+/**
+ * Interprets a Float32 as an Uint32.
+ *
+ * @param value: The value to convert
+ * @returns The Float32 interpreted as an Uint32
+ *
+ * @example assert Uint32.reinterpretFloat32(1.0f) == 1065353216ul
+ * @example assert Uint32.reinterpretFloat32(-1.0f) == 3212836864ul
+ *
+ * @since v0.7.0
+ */
+@unsafe
+provide let reinterpretFloat32 = (value: Float32) => {
+  let x = WasmI32.load(WasmI32.fromGrain(value), _FLOAT32_VALUE_OFFSET)
   let result = newUint32(x)
   WasmI32.toGrain(result): Uint32
 }