pysad.statistics.CountMeter

class pysad.statistics.CountMeter[source]

A simple counter statistic.

Attrs:

count (int): The number of items that are used to update the statistic.

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()[source]

Method to obtain the tracked statistic.

Returns:

The statistic.

Return type:

float

remove(num=None)[source]

Updates the statistic by removing particular value. This method

Parameters:

num (float) – The value to be removed.

Returns:

self.

Return type:

object

update(num)[source]

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