@grain/stdlib 0.5.3 → 0.5.4

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
@@ -612,9 +731,16 @@ Returns:
 
 ### Number.**sin**
 
-<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
@@ -637,9 +763,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 +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.3",
+  "version": "0.5.4",
   "description": "The standard library for the Grain language.",
   "license": "MIT",
   "homepage": "https://grain-lang.org",

package/priorityqueue.gr

@@ -219,6 +219,29 @@ export let drain = pq => {
   List.reverse(drainRec([]))
 }
 
+/**
+ * Constructs a new priority queue initialized with the elements in the array
+ * using a custom comparator function, which is used to determine priority of
+ * elements. The comparator function takes two elements and must return 0 if
+ * both share priority, a positive number if the first has greater priority,
+ * and a negative number if the first has less priority.
+ * 
+ * @param array: An array of values used to initialize the priority queue
+ * @param comp: A comparator function used to assign priority to elements
+ * @returns A priority queue containing the elements from the array
+ *
+ * @since v0.5.4
+ */
+export let fromArray = (array, comp) => {
+  let size = Array.length(array)
+  let array = Array.map(x => Some(x), array)
+  let heap = { size, array, comp }
+  for (let mut i = size - 1; i >= 0; i -= 1) {
+    siftDown(i, heap)
+  }
+  heap
+}
+
 /**
  * Constructs a new priority queue initialized with the elements in the list
  * using a custom comparator function, which is used to determine priority of
@@ -233,9 +256,6 @@ export let drain = pq => {
  * @since v0.5.3
  */
 export let fromList = (list, comp) => {
-  let heap = makeSized(List.length(list), comp)
-  List.forEach(val => {
-    push(val, heap)
-  }, list)
-  heap
+  let array = Array.fromList(list)
+  fromArray(array, comp)
 }

package/priorityqueue.md

@@ -247,6 +247,36 @@ Returns:
 |----|-----------|
 |`List<a>`|A list of all elements in the priority in priority order|
 
+### PriorityQueue.**fromArray**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+fromArray : (Array<a>, ((a, a) -> Number)) -> PriorityQueue<a>
+```
+
+Constructs a new priority queue initialized with the elements in the array
+using a custom comparator function, which is used to determine priority of
+elements. The comparator function takes two elements and must return 0 if
+both share priority, a positive number if the first has greater priority,
+and a negative number if the first has less priority.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`array`|`Array<a>`|An array of values used to initialize the priority queue|
+|`comp`|`(a, a) -> Number`|A comparator function used to assign priority to elements|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`PriorityQueue<a>`|A priority queue containing the elements from the array|
+
 ### PriorityQueue.**fromList**
 
 <details disabled>

package/queue.gr

@@ -15,13 +15,26 @@ record Queue<a> {
 }
 
 /**
- * @section Values: Functions for working with queues.
+ * @section Values: Functions and constants for working with queues.
  */
 
+/**
+ * An empty queue.
+ * 
+ * @since v0.5.4
+ */
+export let empty = {
+  let empty = { forwards: [], backwards: [] }
+  empty
+}
+
 /**
  * Creates an empty queue.
  * 
  * @returns An empty queue
+ * 
+ * @deprecated This will be removed in the v0.6.0 release of Grain.
+ * 
  * @since v0.2.0
  */
 export let make = () => {

package/queue.md

@@ -25,10 +25,25 @@ type Queue<a>
 
 ## Values
 
-Functions for working with queues.
+Functions and constants for working with queues.
+
+### Queue.**empty**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.5.4</code></summary>
+No other changes yet.
+</details>
+
+```grain
+empty : Queue<a>
+```
+
+An empty queue.
 
 ### Queue.**make**
 
+> **Deprecated:** This will be removed in the v0.6.0 release of Grain.
+
 <details disabled>
 <summary tabindex="-1">Added in <code>0.2.0</code></summary>
 No other changes yet.