SortModuleTimes.Stats Class Reference

Inheritance diagram for SortModuleTimes.Stats:

Public Member Functions
def	__init__
def	clear
def	add
def	n
def	weights
def	sum
def	min
def	max
def	sumsq
def	average
def	sqaverage
def	rms2
def	rms
def	stdev
def	stdevp

Public Attributes
	e_n
	e_w
	e_sum
	e_sumsq
	e_min
	e_max

Detailed Description

Statistics collector.

This class accumulates statistics on a single variable.
A new entry is added by add(), that allowes an optional weight.
At any time, the following information about the sample of x is available:
- n():       number of additions
- weights(): total weight (matches n() unless weights are specified)
- sum():     weighted sum of x
- min():     minimum value of x seen so far (None if no entries yet)
- max():     maximum value of x seen so far (None if no entries yet)
- sumsq():   weighted sum of x^2
- average(): weighted average of x (0 if no entries yet)
- sqaverage(): weighted average of x^2 (0 if no entries yet)
- rms():     the Root Mean Square (including weights)
- rms2():    the square of the RMS (including weights)
- stdev():   standard deviation (0 if less than two events)
- stdevp():  an alias for rms()

The construction allows to specify bFloat = false, in which case the
accumulators are integral types (int) until a real type value or weight is
add()ed.

Definition at line 45 of file SortModuleTimes.py.

Constructor & Destructor Documentation

def SortModuleTimes.Stats.__init__	(		self,
			bFloat = True
	)

Statistics collector.

This class accumulates statistics on a single variable.
A new entry is added by add(), that allowes an optional weight.
At any time, the following information about the sample of x is available:
- n():       number of additions
- weights(): total weight (matches n() unless weights are specified)
- sum():     weighted sum of x
- min():     minimum value of x seen so far (None if no entries yet)
- max():     maximum value of x seen so far (None if no entries yet)
- sumsq():   weighted sum of x^2
- average(): weighted average of x (0 if no entries yet)
- sqaverage(): weighted average of x^2 (0 if no entries yet)
- rms():     the Root Mean Square (including weights)
- rms2():    the square of the RMS (including weights)
- stdev():   standard deviation (0 if less than two events)
- stdevp():  an alias for rms()

The construction allows to specify bFloat = false, in which case the
accumulators are integral types (int) until a real type value or weight is
add()ed.

Definition at line 68 of file SortModuleTimes.py.

        def __init__(self, bFloat = True):
                self.clear(bFloat)