windowedInPlace

fun <T> List<T>.windowedInPlace(windowSize: Int, step: Int = 1, partialWindows: Boolean = false): WindowedList<T>(source)

Returns a list of windows with the given windowSize sliding with the given step. Each window is a view into the original list. Changes in the original list will be reflected in the windows.

Return

A WindowedList containing the windows.

Parameters

windowSize

The desired size of each window. Must be greater than 0.

step

The step size between consecutive windows. Defaults to 1.

partialWindows

Whether or not to include partial windows at the end of the list if any. Defaults to false.

Throws

if windowSize or step is less than or equal to 0.