@grain/stdlib 0.5.3 → 0.5.5

package/number.md

@@ -17,6 +17,32 @@ import Number from "number"
 
 Number constant values.
 
+### Number.**nan**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+nan : Number
+```
+
+NaN represented as a Number value.
+
+### Number.**infinity**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+infinity : Number
+```
+
+Infinity represented as a Number value.
+
 ### Number.**pi**
 
 <details disabled>
@@ -164,6 +190,57 @@ Returns:
 |----|-----------|
 |`Number`|The quotient of the two operands|
 
+### Number.**pow**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+pow : (Number, Number) -> Number
+```
+
+Computes the exponentiation of the given base and power.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`base`|`Number`|The base number|
+|`power`|`Number`|The exponent number|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The base raised to the given power|
+
+### Number.**exp**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+exp : Number -> Number
+```
+
+Computes the exponentiation of Euler's number to the given power.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`power`|`Number`|The exponent number|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The `Number.e` value raised to the given power|
+
 ### Number.**sqrt**
 
 <details disabled>
@@ -225,9 +302,16 @@ Number.sign(0) == 0
 
 ### Number.**min**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.4.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.5.4</code></td><td>Handle NaN properly</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
@@ -251,9 +335,16 @@ Returns:
 
 ### Number.**max**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.4.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.5.4</code></td><td>Handle NaN properly</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
@@ -277,9 +368,16 @@ Returns:
 
 ### Number.**ceil**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.4.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.5.4</code></td><td>Handle NaN and Infinity properly</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
@@ -302,9 +400,16 @@ Returns:
 
 ### Number.**floor**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.4.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.5.4</code></td><td>Handle NaN and Infinity properly</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
@@ -327,9 +432,16 @@ Returns:
 
 ### Number.**trunc**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.4.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.5.4</code></td><td>Handle NaN and Infinity properly</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
@@ -352,9 +464,16 @@ Returns:
 
 ### Number.**round**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.4.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.5.4</code></td><td>Handle NaN and Infinity properly</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
@@ -610,13 +729,72 @@ Returns:
 |----|-----------|
 |`Result<Number, String>`|`Ok(value)` containing the parsed number on a successful parse or `Err(msg)` containing an error message string otherwise|
 
-### Number.**sin**
+### Number.**parseFloat**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>0.5.2</code></summary>
+<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>
+<summary>Added in <code>0.5.2</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.5.4</code></td><td>Handle NaN and Infinity</td></tr>
+</tbody>
+</table>
+</details>
+
 ```grain
 sin : Number -> Number
 ```
@@ -637,9 +815,16 @@ Returns:
 
 ### Number.**cos**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.2</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.5.2</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.5.4</code></td><td>Handle NaN and Infinity</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
@@ -660,3 +845,140 @@ Returns:
 |----|-----------|
 |`Number`|The computed cosine|
 
+### Number.**tan**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+tan : Number -> Number
+```
+
+Computes the tangent of a number (in radians) using Chebyshev polynomials.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`radians`|`Number`|The input in radians|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The computed tangent|
+
+### Number.**gamma**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+gamma : Number -> Number
+```
+
+Computes the gamma function of a value using Lanczos approximation.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`z`|`Number`|The value to interpolate|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The gamma of the given value|
+
+Throws:
+
+`InvalidArgument(String)`
+
+* When `z` is zero
+
+### Number.**factorial**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+factorial : Number -> Number
+```
+
+Computes the product of consecutive integers for an integer input and computes the gamma function for non-integer inputs.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`n`|`Number`|The value to factorialize|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The factorial of the given value|
+
+Throws:
+
+`InvalidArgument(String)`
+
+* When `n` is negative
+
+### Number.**toRadians**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+toRadians : Number -> Number
+```
+
+Converts degrees to radians.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`degrees`|`Number`|The value to convert|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The value in radians|
+
+### Number.**toDegrees**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+toDegrees : Number -> Number
+```
+
+Converts radians to degrees.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`radians`|`Number`|The value to convert|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The value in degrees|
+

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.3",
+  "version": "0.5.5",
   "description": "The standard library for the Grain language.",
   "license": "MIT",
   "homepage": "https://grain-lang.org",