staircase.Stairs.min

Stairs.min(lower=-inf, upper=inf)

Calculates the minimum value of the step function.

If an interval which to calculate over is specified it is interpreted as a closed interval

Parameters:

• lower (int, float or pandas.Timestamp, optional) – lower bound of the interval on which to perform the calculation
• upper (int, float or pandas.Timestamp, optional) – upper bound of the interval on which to perform the calculation

Returns:

The minimum value of the step function

Return type:

float

See also

Stairs.max(), staircase.min()

Examples

>>> s2.plot()
>>> s2.min(0,3)
-1.0
>>> s2.min(1,2.5)
0.0