11.2 Statistics Class

The Statistics Class is used to describe a Statistics object in the CÆSAR Code Package. A Statistics object contains statistical information about a set of values that have been added to it. The statistical information that is available includes means (arithmetic, geometric and harmonic), extrema and the standard deviation. It does not include information that would require the storage of the entire set of values, such as median and mode.

The Statistics methods section describes the methods used in the Statistics Class.

Statistics public procedures:

	Fundamental procedures
	Initialize		Initializes a Statistics object.
	Finalize		Finalizes a Statistics object.
	Valid_State		Returns false iff a Statistics object is in an invalid state.
	Initialized		Returns true iff a Statistics object has been initialized.
	Operations
	Add_Value		Adds a value to the data set of the Statistics object.
	Arithmetic_Mean		Returns the arithmetic mean of the Statistics object.
	Average		Returns the arithmetic mean of the Statistics object.
	Count		Returns the number of values in the Statistics object.
	Geometric_Mean		Returns the geometric mean of the Statistics object.
	Harmonic_Mean		Returns the harmonic mean of the Statistics object.
	Maximum		Returns the maximum value of the Statistics object.
	Mean		Returns the arithmetic mean of the Statistics object.
	Minimum		Returns the minimum value of the Statistics object.
	Name		Returns the name of the Statistics object.
	Output		Writes out the Statistics object.
	Standard_Deviation		Returns the standard deviation of the Statistics object.
	Sum		Returns the sum or total of the Statistics object.
	Total		Returns the sum or total of the Statistics object.
	Totally_Positive		Returns true if all the values in the Statistics object are positive.
	Update_Global		Communicates with all processors to update the global information for the Statistics object.

Statistics public defined types:

	Statistics type
	Global_Arithmetic_Mean		The global arithmetic mean.
	Global_Count		The global number of items in the data set.
	Global_Geometric_Mean		The global geometric mean.
	Global_Harmonic_Mean		The global harmonic mean.
	Global_Log_Sum		The global sum of the log of the values.
	Global_Maximum		The global maximum of the values.
	Global_Minimum		The global minimum of the values.
	Global_Reciprocal_Sum		The global sum of the reciprocal of the values.
	Global_Squared_Sum		The global sum of the squares of the values.
	Global_Standard_Deviation		The global standard deviation.
	Global_Sum		The global sum of values.
	Global_Totally_Positive		True if all items in the data set on all PEs are positive.
	Global_Updated		Global update status.
	Initialized		Initialization status.
	Name		The name for this Statistics object.
	PE_Arithmetic_Mean		The arithmetic mean on this PE.
	PE_Count		The number of items in the data set on this PE.
	PE_Geometric_Mean		The geometric mean on this PE.
	PE_Harmonic_Mean		The harmonic mean on this PE.
	PE_Log_Sum		The sum of the log of the values on this PE.
	PE_Maximum		The maximum of the values on this PE.
	PE_Minimum		The minimum of the values on this PE.
	PE_Reciprocal_Sum		The sum of the reciprocal of the values on this PE.
	PE_Squared_Sum		The sum of the squares of the values on this PE.
	PE_Standard_Deviation		The standard deviation on this PE.
	PE_Sum		The sum of values on this PE.
	PE_Totally_Positive		True if all items in the data set on this PE are positive.

The Statistics Class code listing contains additional documentation. The Statistics Class also contains a Unit Test Program.