Function slidingWindows
- sliding
Windows <T>(array, size, options?): T[][] Type Parameters
Parameters
- array: readonly T[]
The array to generate sliding windows from.
- size: number
The size of the sliding windows.
- options: SlidingWindowsOptions = {}
The options for generating sliding windows.
Returns T[][]
A new array containing all sliding windows of the given size.
Example: Usage
import { slidingWindows } from "@std/collections/sliding-windows";
import { assertEquals } from "@std/assert";
const numbers = [1, 2, 3, 4, 5];
const windows = slidingWindows(numbers, 3);
assertEquals(windows, [
[1, 2, 3],
[2, 3, 4],
[3, 4, 5],
]);
const windowsWithStep = slidingWindows(numbers, 3, { step: 2 });
assertEquals(windowsWithStep, [
[1, 2, 3],
[3, 4, 5],
]);
const windowsWithPartial = slidingWindows(numbers, 3, { partial: true });
assertEquals(windowsWithPartial, [
[1, 2, 3],
[2, 3, 4],
[3, 4, 5],
[4, 5],
[5],
]);- array: readonly T[]
Generates sliding views of the given array of the given size and returns a new array containing all of them.
If step is set, each window will start that many elements after the last window's start. (Default: 1)
If partial is set, windows will be generated for the last elements of the collection, resulting in some undefined values if size is greater than 1.