Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(stdlib)!: Reorder parameters to List.insert #1857

Merged
merged 3 commits into from
Jul 1, 2023
Merged

feat(stdlib)!: Reorder parameters to List.insert #1857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b718665
feat(stdlib)!: Adjust `List.insert` param order
alex-snezhko Jun 12, 2023
5b5b951
regen graindoc
alex-snezhko Jun 12, 2023
ee3ab2d
added history entry
alex-snezhko Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions compiler/test/stdlib/list.test.gr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,10 @@ assert flatten([list, []]) == list

// List.insert

assert insert(1, 0, []) == [1]
assert insert(0, 1, []) == [1]
assert insert(0, 0, list) == [0, 1, 2, 3]
assert insert(0, 2, list) == [1, 2, 0, 3]
assert insert(0, 3, list) == [1, 2, 3, 0]
assert insert(2, 0, list) == [1, 2, 0, 3]
assert insert(3, 0, list) == [1, 2, 3, 0]

// List.count

Expand Down
7 changes: 4 additions & 3 deletions stdlib/list.gr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,25 +451,26 @@ provide let rec flatten = list => {
/**
* Inserts a new value into a list at the specified index.
*
* @param value: The value to insert
* @param index: The index to update
* @param value: The value to insert
* @param list: The list to update
* @returns The new list
*
* @throws Failure(String): When `index` is negative
* @throws Failure(String): When `index` is more than 0 and greater than the list size
*
* @since v0.1.0
* @history v0.6.0: Swapped order of `index` and `value` parameters
*/
provide let rec insert = (value, index, list) => {
provide let rec insert = (index, value, list) => {
if (index < 0) {
fail "insert index cannot be a negative number"
} else {
match (list) {
[] => if (index == 0) [value] else fail "insert index is out-of-bounds",
[first, ...rest] =>
if (index == 0) [value, ...list]
else [first, ...insert(value, index - 1, rest)],
else [first, ...insert(index - 1, value, rest)],
}
}
}
Expand Down
17 changes: 12 additions & 5 deletions stdlib/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,13 +689,20 @@ List.flatten([[1, 2], [3, 4]]) // [1, 2, 3, 4]

### List.**insert**

<details disabled>
<summary tabindex="-1">Added in <code>0.1.0</code></summary>
No other changes yet.
<details>
<summary>Added in <code>0.1.0</code></summary>
<table>
<thead>
<tr><th>version</th><th>changes</th></tr>
</thead>
<tbody>
<tr><td><code>next</code></td><td>Swapped order of `index` and `value` parameters</td></tr>
</tbody>
</table>
</details>

```grain
insert : (value: a, index: Number, list: List<a>) => List<a>
insert : (index: Number, value: a, list: List<a>) => List<a>
```

Inserts a new value into a list at the specified index.
Expand All @@ -704,8 +711,8 @@ Parameters:

|param|type|description|
|-----|----|-----------|
|`value`|`a`|The value to insert|
|`index`|`Number`|The index to update|
|`value`|`a`|The value to insert|
|`list`|`List<a>`|The list to update|

Returns:
Expand Down