pandas.api.indexers.BaseIndexer.get_window_bounds#

BaseIndexer.get_window_bounds(num_values=0, min_periods=None, center=None, closed=None, step=None)[source]#

Computes the bounds of a window.

Parameters
num_valuesint, default 0

number of values that will be aggregated over

window_sizeint, default 0

the number of rows in a window

min_periodsint, default None

min_periods passed from the top level rolling API

centerbool, default None

center passed from the top level rolling API

closedstr, default None

closed passed from the top level rolling API

stepint, default None

step passed from the top level rolling API .. versionadded:: 1.5

win_typestr, default None

win_type passed from the top level rolling API

Returns
A tuple of ndarray[int64]s, indicating the boundaries of each
window