Kubit/kubit.collections.inplace.primitives/windowedInPlace

windowedInPlace

fun IntList.windowedInPlace(windowSize: Int, step: Int = 1, partialWindows: Boolean = false): WindowedIntList(source)

Returns a WindowedIntList with the given windowSize sliding by step. Each window is a view into the original list.

Return

A WindowedIntList 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 to include partial windows at the end. Defaults to false.

Throws

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

fun LongList.windowedInPlace(windowSize: Int, step: Int = 1, partialWindows: Boolean = false): WindowedLongList(source)

Returns a WindowedLongList with the given windowSize sliding by step. Each window is a view into the original list.

Return

A WindowedLongList 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 to include partial windows at the end. Defaults to false.

Throws

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

fun FloatList.windowedInPlace(windowSize: Int, step: Int = 1, partialWindows: Boolean = false): WindowedFloatList(source)

Returns a WindowedFloatList with the given windowSize sliding by step. Each window is a view into the original list.

Return

A WindowedFloatList 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 to include partial windows at the end. Defaults to false.

Throws

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

fun DoubleList.windowedInPlace(windowSize: Int, step: Int = 1, partialWindows: Boolean = false): WindowedDoubleList(source)

Returns a WindowedDoubleList with the given windowSize sliding by step. Each window is a view into the original list.

Return

A WindowedDoubleList 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 to include partial windows at the end. Defaults to false.

Throws

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