Rename std.array.imap to std.array.map_with_index (tweag#1829)

Jasha10 · Feb 29, 2024 · 27d7185 · 27d7185
1 parent 20809d3
commit 27d7185
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/core/stdlib/std.ncl b/core/stdlib/std.ncl
@@ -771,17 +771,17 @@
  (fun i => f (std.array.at i xs) (std.array.at i ys))
  (std.number.min (std.array.length xs) (std.array.length ys)),
 
- imap
+ map_with_index
  : forall a b. (Number -> a -> b) -> Array a -> Array b
  | doc m%"
  Applies a function to every element in the given array while passing
  its (0-based) index. That is,
- `imap f [ x1, x2, ... ]` is `[ f 0 x1, f 1 x2, ... ]`.
+ `map_with_index f [ x1, x2, ... ]` is `[ f 0 x1, f 1 x2, ... ]`.
 
  # Examples
 
  ```nickel
- std.array.map (fun i x => i + x + 1) [ 1, 2, 3 ] =>
+ std.array.map_with_index (fun i x => i + x + 1) [ 1, 2, 3 ] =>
  [ 2, 4, 6 ]
  ```
  "%

diff --git a/core/tests/integration/inputs/core/arrays.ncl b/core/tests/integration/inputs/core/arrays.ncl
@@ -47,6 +47,6 @@ let {check, ..} = import "../lib/assert.ncl" in
  std.array.zip_with (*) [1, 2] [4, 5, 6] == [4, 10],
  std.array.zip_with (-) [1, 2, 3] [4, 5] == [-3, -3],
 
- std.array.imap (+) [1, 2, 3] == [1, 3, 5],
+ std.array.map_with_index (+) [1, 2, 3] == [1, 3, 5],
 ]
 |> check