Arrays.correlate()
Syntax
function correlate<A, B, ...>(source1: readonly A[], source2: readonly B[], ..., callback: (a: A, b: B, ...) => void): void
Iterates through several arrays of the same length at once, calling a callback function with all the array elements at that index at each step.
| Parameters | |
sourceN
|
Any number of arrays whose corresponding elements should be added as arguments to the callback function. All arrays must have the same length or this function will throw an error. |
callback
|
A callback function which receives all the array elements at the current iteration index as arguments. For instance, if you pass three arrays of length two, the callback function will be called twice. Once with the arguments |
Example
import { Arrays } from 'potence';
const array1 = [1, 2, 3];
const array2 = [4, 5, 6];
const array3 = [7, 8, 9];
const results = [];
Arrays.correlate(array1, array2, array3, (a, b, c) => results.push(a + b + c));
// -> turns into [1 + 4 + 7, 2 + 5 + 8, 3 + 6 + 9]
// -> results: [12, 15, 18]
Remarks
This function does not build any temporary objects and is therefore faster than
using Arrays.zip()
for the same purpose.
Note for TypeScript users: This function cannot use a
rest parameter
due to the fact that the arrays come first, then the callback function. This is
a deliberate choice to make usage of the function more intuitive but has the
unfortunate drawback that there is no generic way to type this function
with an unlimited number of arguments. As a result, TypeScript expects a maximum
of 10 arrays. If you’d like to use more or if you’d like to spread a
two-dimensional array into the function, you may have to disable type-checking
for that line using // @ts-ignore in the preceding line.