pysad.statistics.AbsStatistic

class pysad.statistics.AbsStatistic(statistic_cls, **kwargs)

The absolute value of the statistic that is tracked.

Parameters:

• statistic_cls (class) – The class of the statistic to be instiantiated.

• **kwargs (Keyword arguments) – The keyword arguments that is input to the statistic_cls.

Methods

__init__(statistic_cls, **kwargs)
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