@grain/stdlib 0.5.2 → 0.5.4

package/number.md

@@ -17,10 +17,36 @@ 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>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.5.2</code></summary>
 No other changes yet.
 </details>
 
@@ -33,7 +59,7 @@ Pi represented as a Number value.
 ### Number.**tau**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.5.2</code></summary>
 No other changes yet.
 </details>
 
@@ -46,7 +72,7 @@ Tau represented as a Number value.
 ### Number.**e**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>next</code></summary>
+<summary tabindex="-1">Added in <code>0.5.2</code></summary>
 No other changes yet.
 </details>
 
@@ -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
@@ -425,6 +544,81 @@ Returns:
 |----|-----------|
 |`Number`|The negated operand|
 
+### Number.**isFloat**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.3</code></summary>
+No other changes yet.
+</details>
+
+```grain
+isFloat : Number -> Bool
+```
+
+Checks if a number is a floating point value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Number`|The number to check|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the value is a floating point number or `false` otherwise|
+
+### Number.**isInteger**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.3</code></summary>
+No other changes yet.
+</details>
+
+```grain
+isInteger : Number -> Bool
+```
+
+Checks if a number is an integer.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Number`|The number to check|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the value is an integer or `false` otherwise|
+
+### Number.**isRational**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.3</code></summary>
+No other changes yet.
+</details>
+
+```grain
+isRational : Number -> Bool
+```
+
+Checks if a number is a non-integer rational value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Number`|The number to check|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the value is a non-integer rational number or `false` otherwise|
+
 ### Number.**isFinite**
 
 <details disabled>
@@ -537,9 +731,16 @@ Returns:
 
 ### Number.**sin**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>next</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
@@ -562,9 +763,16 @@ Returns:
 
 ### Number.**cos**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>next</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
@@ -585,3 +793,130 @@ 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.
+Fails when the given value is zero.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`z`|`Number`|The value to interpolate|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The gamma of the given value|
+
+### 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.
+Fails if the input is a negative number.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`n`|`Number`|The value to factorialize|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The factorial of the given value|
+
+### 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/package.json

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

package/pervasives.gr

@@ -11,6 +11,7 @@ import Memory from "runtime/unsafe/memory"
 import WasmI32 from "runtime/unsafe/wasmi32"
 
 import { equal as (==) } from "runtime/equal"
+import { compare } from "runtime/compare"
 
 import {
   incr,
@@ -218,6 +219,19 @@ export (<=)
  */
 export (>=)
 
+/**
+ * Compares the first argument to the second argument and produces an integer result.
+ * Provides a consistent ordering over all types and is suitable for sorting and other kinds of ordering.
+ * `compare` treats `NaN` differently than the other comparison operators in that it considers `NaN` equal to itself and smaller than any other number.
+ *
+ * @param num1: The first operand
+ * @param num2: The second operand
+ * @returns A negative integer if the first operand is less than the second operand, `0` if they are equal, or a positive integer otherwise
+ *
+ * @since v0.5.3
+ */
+export compare
+
 /**
  * @section Math operations: Infix functions for working with Number values.
  */
@@ -410,7 +424,7 @@ export (>>)
 
 // Number coercions & conversions
 
-// [TODO] (#311) Commented until we nail down semantics
+// TODO(#311): Commented until we nail down semantics
 // import foreign wasm convertExactToInexact : Number -> Number as inexact from "stdlib-external/runtime"
 // import foreign wasm convertInexactToExact : Number -> Number as exact from "stdlib-external/runtime"
 
@@ -553,10 +567,7 @@ export primitive unbox: Box<a> -> a = "@unbox"
  * @since v0.4.0
  */
 export let cons = (a, b) =>
-  [
-    a,
-    ...b
-  ] // <- workaround for (grain-lang/grain#802) [TODO] fix #802 and delete
+  [a, ...b] // TODO(#802): Remove workaround after 802 is completed
 /**
  * The empty list syntax (`[]`) provided as a value.
  *

package/pervasives.md

@@ -369,6 +369,34 @@ Returns:
 |----|-----------|
 |`Bool`|`true` if the first operand is greater than or equal to the second operand or `false` otherwise|
 
+### Pervasives.**compare**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.3</code></summary>
+No other changes yet.
+</details>
+
+```grain
+compare : (a, a) -> Number
+```
+
+Compares the first argument to the second argument and produces an integer result.
+Provides a consistent ordering over all types and is suitable for sorting and other kinds of ordering.
+`compare` treats `NaN` differently than the other comparison operators in that it considers `NaN` equal to itself and smaller than any other number.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`num1`|`a`|The first operand|
+|`num2`|`a`|The second operand|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|A negative integer if the first operand is less than the second operand, `0` if they are equal, or a positive integer otherwise|
+
 ## Math operations
 
 Infix functions for working with Number values.