pysad.statistics.MaxMeter

class pysad.statistics.MaxMeter

The statistic that keeps track of the maximum value.

Attrs:

max (float): The maximum value. lst (list[float]): The list of values that are used to update the statistic. It is necessary for windowing operations.

Methods

__init__()
get()	Method to obtain the tracked statistic.
remove(num)	Updates the statistic by removing particular value.
update(num)	Updates the statistic with the value for a timestep.

get()

Method to obtain the tracked statistic.

Returns:

The statistic.

Return type:

float

remove(num)

Updates the statistic by removing particular value. This method

Parameters:

num (float) – The value to be removed.

Returns:

self.

Return type:

object

update(num)

Updates the statistic with the value for a timestep.

Parameters:

num (float) – The incoming value, for which the statistic is used.

Returns:

self.

Return type:

object