@grain/stdlib 0.5.4 → 0.5.5

package/number.gr

@@ -18,8 +18,9 @@ import {
   isBoxedNumber,
   scalbn,
 } from "runtime/numbers"
-import { parseInt } from "runtime/stringUtils"
-import { newFloat64, newInt64 } from "runtime/dataStructures"
+import Atoi from "runtime/atoi/parse"
+import Atof from "runtime/atof/parse"
+import { newFloat64, newInt64, allocateString } from "runtime/dataStructures"
 import Tags from "runtime/unsafe/tags"
 import Exception from "runtime/exception"
 
@@ -890,7 +891,80 @@ export let isInfinite = (x: Number) => {
  *
  * @since v0.4.5
  */
-export parseInt
+export let parseInt = Atoi.parseInt
+
+/**
+ * Parses a string representation of a float into a `Number`. Underscores that appear
+ * in numeric portions of the input are ignored.
+ *
+ * @param input: The string to parse
+ * @returns `Ok(value)` containing the parsed number on a successful parse or `Err(msg)` containing an error message string otherwise
+ *
+ * @since v0.5.5
+ */
+export let parseFloat = Atof.parseFloat
+
+/**
+ * Parses a string representation of an integer, float, or rational into a `Number`.
+ * Underscores that appear in the numeric portion of the input are ignored.
+ *
+ * @param input: The string to parse
+ * @returns `Ok(value)` containing the parsed number on a successful parse or `Err(msg)` containing an error message string otherwise
+ *
+ * @since v0.5.5
+ */
+@unsafe
+export let parse = input => {
+  match (parseInt(input, 10)) {
+    Ok(number) => Ok(number),
+    Err(msg) =>
+      match (parseFloat(input)) {
+        Ok(number) => Ok(number),
+        Err(_) => {
+          // Split the input on a `/` and attempt to parse a rational
+          let (+) = WasmI32.add
+          let (-) = WasmI32.sub
+          let (<) = WasmI32.ltU
+          let (==) = WasmI32.eq
+
+          // Search for `/`
+          let input = WasmI32.fromGrain(input)
+          let len = WasmI32.load(input, 4n)
+          let mut slashIdx = -1n
+          for (let mut i = 0n; i < len; i += 1n) {
+            if (WasmI32.load8U(input + i, 8n) == 0x2fn) {
+              slashIdx = i
+              break
+            }
+          }
+
+          if (slashIdx == -1n) {
+            Err(msg)
+          } else {
+            let numeratorLen = slashIdx
+            let denominatorLen = len - slashIdx - 1n
+
+            let numerator = allocateString(numeratorLen)
+            Memory.copy(numerator + 8n, input + 8n, numeratorLen)
+            let numerator = WasmI32.toGrain(numerator): String
+
+            let denominator = allocateString(denominatorLen)
+            Memory.copy(
+              denominator + 8n,
+              input + 8n + slashIdx + 1n,
+              denominatorLen
+            )
+            let denominator = WasmI32.toGrain(denominator): String
+
+            match ((parseInt(numerator, 10), parseInt(denominator, 10))) {
+              (Ok(numerator), Ok(denominator)) => Ok(numerator / denominator),
+              (Err(msg), _) | (_, Err(msg)) => Err(msg),
+            }
+          }
+        },
+      },
+  }
+}
 
 /**
  * Computes how many times pi has to be subtracted to achieve the required bounds for sin.
@@ -974,11 +1048,12 @@ export let tan = (radians: Number) => {
 // https://en.wikipedia.org/wiki/Lanczos_approximation
 /**
  * Computes the gamma function of a value using Lanczos approximation.
- * Fails when the given value is zero.
  *
  * @param z: The value to interpolate
  * @returns The gamma of the given value
  *
+ * @throws InvalidArgument(String): When `z` is zero
+ *
  * @since v0.5.4
  */
 export let rec gamma = z => {
@@ -1026,11 +1101,12 @@ export let rec gamma = z => {
 
 /**
  * Computes the product of consecutive integers for an integer input and computes the gamma function for non-integer inputs.
- * Fails if the input is a negative number.
  *
  * @param n: The value to factorialize
  * @returns The factorial of the given value
  *
+ * @throws InvalidArgument(String): When `n` is negative
+ *
  * @since v0.5.4
  */
 export let rec factorial = n => {

package/number.md

@@ -729,6 +729,58 @@ Returns:
 |----|-----------|
 |`Result<Number, String>`|`Ok(value)` containing the parsed number on a successful parse or `Err(msg)` containing an error message string otherwise|
 
+### Number.**parseFloat**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.5</code></summary>
+No other changes yet.
+</details>
+
+```grain
+parseFloat : String -> Result<Number, String>
+```
+
+Parses a string representation of a float into a `Number`. Underscores that appear
+in numeric portions of the input are ignored.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`input`|`String`|The string to parse|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Result<Number, String>`|`Ok(value)` containing the parsed number on a successful parse or `Err(msg)` containing an error message string otherwise|
+
+### Number.**parse**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.5</code></summary>
+No other changes yet.
+</details>
+
+```grain
+parse : String -> Result<Number, String>
+```
+
+Parses a string representation of an integer, float, or rational into a `Number`.
+Underscores that appear in the numeric portion of the input are ignored.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`input`|`String`|The string to parse|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Result<Number, String>`|`Ok(value)` containing the parsed number on a successful parse or `Err(msg)` containing an error message string otherwise|
+
 ### Number.**sin**
 
 <details>
@@ -830,7 +882,6 @@ gamma : Number -> Number
 ```
 
 Computes the gamma function of a value using Lanczos approximation.
-Fails when the given value is zero.
 
 Parameters:
 
@@ -844,6 +895,12 @@ Returns:
 |----|-----------|
 |`Number`|The gamma of the given value|
 
+Throws:
+
+`InvalidArgument(String)`
+
+* When `z` is zero
+
 ### Number.**factorial**
 
 <details disabled>
@@ -856,7 +913,6 @@ factorial : Number -> Number
 ```
 
 Computes the product of consecutive integers for an integer input and computes the gamma function for non-integer inputs.
-Fails if the input is a negative number.
 
 Parameters:
 
@@ -870,6 +926,12 @@ Returns:
 |----|-----------|
 |`Number`|The factorial of the given value|
 
+Throws:
+
+`InvalidArgument(String)`
+
+* When `n` is negative
+
 ### Number.**toRadians**
 
 <details disabled>

package/option.gr

@@ -1,13 +1,13 @@
 /**
  * @module Option: Utilities for working with the Option data type.
- * 
+ *
  * The Option type is an enum that represents the possibility of something being present (with the `Some` variant), or not (with the `None` variant). There’s no standalone `null` or `nil` type in Grain; use an Option where you would normally reach for `null` or `nil`.
- * 
+ *
  * @example import Option from "option"
- * 
+ *
  * @example let hasValue = Some(1234) // Creates an Option containing 1234
  * @example let noValue = None // Creates an Option containing nothing
- * 
+ *
  * @since v0.2.0
  */
 
@@ -20,7 +20,7 @@
  *
  * @param option: The option to check
  * @returns `true` if the Option is the `Some` variant or `false` otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let isSome = option => {
@@ -35,7 +35,7 @@ export let isSome = option => {
  *
  * @param option: The option to check
  * @returns `true` if the Option is the `None` variant or `false` otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let isNone = option => {
@@ -51,7 +51,7 @@ export let isNone = option => {
  * @param value: The value to search for
  * @param option: The option to search
  * @returns `true` if the Option is equivalent to `Some(value)` or `false` otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let contains = (value, option) => {
@@ -68,7 +68,9 @@ export let contains = (value, option) => {
  * @param msg: The message to use upon failure
  * @param option: The option to extract a value from
  * @returns The unwrapped value if the Option is the `Some` variant
- * 
+ *
+ * @throws Failure(String): When the `option` is `None`
+ *
  * @since v0.2.0
  */
 export let expect = (msg, option) => {
@@ -79,12 +81,14 @@ export let expect = (msg, option) => {
 }
 
 /**
- * Extracts the value inside a `Some` option, otherwise 
+ * Extracts the value inside a `Some` option, otherwise
  * throws an exception containing a default message.
  *
  * @param option: The option to extract the value from
  * @returns The unwrapped value if the Option is the `Some` variant
- * 
+ *
+ * @throws Failure(String): When the `option` is `None`
+ *
  * @since v0.2.0
  */
 export let unwrap = option => {
@@ -97,7 +101,7 @@ export let unwrap = option => {
  * @param default: The default value
  * @param option: The option to unwrap
  * @returns The unwrapped value if the Option is the `Some` variant or the default value otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let unwrapWithDefault = (default, option) => {
@@ -113,7 +117,7 @@ export let unwrapWithDefault = (default, option) => {
  * @param fn: The function to call on the value of a `Some` variant
  * @param option: The option to map
  * @returns A new `Some` variant produced by the mapping function if the variant was `Some` or the unmodified `None` otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let map = (fn, option) => {
@@ -131,7 +135,7 @@ export let map = (fn, option) => {
  * @param default: A fallback value for a `None` variant
  * @param option: The option to map
  * @returns The value produced by the mapping function if the Option is of the `Some` variant or the default value otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let mapWithDefault = (fn, default, option) => {
@@ -150,7 +154,7 @@ export let mapWithDefault = (fn, default, option) => {
  * @param defaultFn: The default function
  * @param option: The option to map
  * @returns The value produced by one of the mapping functions
- * 
+ *
  * @since v0.2.0
  */
 export let mapWithDefaultFn = (fn, defaultFn, option) => {
@@ -166,7 +170,7 @@ export let mapWithDefaultFn = (fn, defaultFn, option) => {
  * @param fn: The function to call on the value of a `Some` variant
  * @param option: The option to map
  * @returns A new Option produced by the mapping function if the variant was `Some` or the unmodified `None` otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let flatMap = (fn, option) => {
@@ -183,7 +187,7 @@ export let flatMap = (fn, option) => {
  * @param fn: The predicate function to indicate if the option should remain `Some`
  * @param option: The option to inspect
  * @returns `Some(value)` if the variant was `Some` and the predicate returns `true` or `None` otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let filter = (fn, option) => {
@@ -204,7 +208,7 @@ export let filter = (fn, option) => {
  * @param optionA: The first option to combine
  * @param optionB: The second option to combine
  * @returns `Some((valueA, valueB))` if both Options are `Some` variants or `None` otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let zip = (optionA, optionB) => {
@@ -221,7 +225,7 @@ export let zip = (optionA, optionB) => {
  * @param optionA: The first option to combine
  * @param optionB: The second option to combine
  * @returns `Some(newValue)` if both Options are `Some` variants or `None` otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let zipWith = (fn, optionA, optionB) => {
@@ -236,7 +240,7 @@ export let zipWith = (fn, optionA, optionB) => {
  *
  * @param option: The option to flatten
  * @returns `Some(innerValue)` if all nested options were the `Some` variant or `None` otherwise
- * 
+ *
  * @example Option.flatten(Some(Some(1))) == Some(1)
  *
  * @since v0.2.0
@@ -253,7 +257,7 @@ export let flatten = option => {
  *
  * @param option: The option to convert
  * @returns `[value]` if the Option was the `Some` variant or `[]` otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let toList = option => {
@@ -268,7 +272,7 @@ export let toList = option => {
  *
  * @param option: The option to convert
  * @returns `[> value]` if the Option was the `Some` variant or `[> ]` otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let toArray = option => {
@@ -284,7 +288,7 @@ export let toArray = option => {
  * @param err: The error to use if the option is `None`
  * @param option: The option to convert
  * @returns `Ok(value)` if the Option is `Some(value)` or `Err(err)` if the Option is `None`
- * 
+ *
  * @since v0.2.0
  */
 export let toResult = (err, option) => {
@@ -299,7 +303,7 @@ export let toResult = (err, option) => {
  *
  * @param fn: The function to call on the value of a `Some` variant
  * @param option: The option to inspect
- * 
+ *
  * @since v0.2.0
  */
 export let sideEffect = (fn, option) => {
@@ -316,7 +320,7 @@ export let sideEffect = (fn, option) => {
  * @param fn: The function to call on the value of a `Some` variant
  * @param option: The option to inspect
  * @returns The unmodified option
- * 
+ *
  * @since v0.2.0
  */
 export let peek = (fn, option) => {
@@ -330,7 +334,7 @@ export let peek = (fn, option) => {
  * @param optionA: The first option
  * @param optionB: The second option
  * @returns The first Option if it is the `Some` variant or the second Option otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let or = (optionA, optionB) => {
@@ -346,7 +350,7 @@ export let or = (optionA, optionB) => {
  * @param optionA: The first option
  * @param optionB: The second option
  * @returns The second Option if both are the `Some` variant or the first Option otherwise
- * 
+ *
  * @since v0.2.0
  */
 export let and = (optionA, optionB) => {

package/option.md

@@ -130,6 +130,12 @@ Returns:
 |----|-----------|
 |`a`|The unwrapped value if the Option is the `Some` variant|
 
+Throws:
+
+`Failure(String)`
+
+* When the `option` is `None`
+
 ### Option.**unwrap**
 
 <details disabled>
@@ -156,6 +162,12 @@ Returns:
 |----|-----------|
 |`a`|The unwrapped value if the Option is the `Some` variant|
 
+Throws:
+
+`Failure(String)`
+
+* When the `option` is `None`
+
 ### Option.**unwrapWithDefault**
 
 <details disabled>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grain/stdlib",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "The standard library for the Grain language.",
   "license": "MIT",
   "homepage": "https://grain-lang.org",