pandas.core.window.rolling.Rolling.min

Rolling.min(*args, engine=None, engine_kwargs=None, **kwargs)[source]

Calculate the rolling minimum.

Parameters
*args

For NumPy compatibility and will not have an effect on the result.

enginestr, default None

  • 'cython' : Runs the operation through C-extensions from cython.

  • 'numba' : Runs the operation through JIT compiled code from numba.

  • None : Defaults to 'cython' or globally setting compute.use_numba

    New in version 1.3.0.

engine_kwargsdict, default None

  • For 'cython' engine, there are no accepted engine_kwargs

  • For 'numba' engine, the engine can accept nopython, nogil and parallel dictionary keys. The values must either be True or False. The default engine_kwargs for the 'numba' engine is {'nopython': True, 'nogil': False, 'parallel': False}

    New in version 1.3.0.

**kwargs

For NumPy compatibility and will not have an effect on the result.

Returns
Series or DataFrame

Return type is the same as the original object.

See also

pandas.Series.rolling

Calling rolling with Series data.

pandas.DataFrame.rolling

Calling rolling with DataFrames.

pandas.Series.min

Aggregating min for Series.

pandas.DataFrame.min

Aggregating min for DataFrame.

Notes

See Numba engine and Numba (JIT compilation) for extended documentation and performance considerations for the Numba engine.

Examples

Performing a rolling minimum with a window size of 3.

>>> s = pd.Series([4, 3, 5, 2, 6])
>>> s.rolling(3).min()
0    NaN
1    NaN
2    3.0
3    2.0
4    2.0
dtype: float64

previous

pandas.core.window.rolling.Rolling.std

next

pandas.core.window.rolling.Rolling.max