staircase.Stairs.max

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

Calculates the maximum 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 maximum value of the step function

Return type:

float

See also

Stairs.min(), staircase.max()

Examples

>>> s1.plot()
>>> s1.max()
1.0
>>> s1.max(2,3)
1.0