pysad.statistics.SumSquaresMeter

class pysad.statistics.SumSquaresMeter

The statistic that keeps track of the sum of squares. This class is useful to calculate and used in VarianceMeter.

Attrs:

sum_squares (float): The sum of squares of values. num_items (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()

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