ALMaSS Rodenticide Model ODdox  1.0
SimpleStatistics Class Reference

#include <PopulationManager.h>

Public Member Functions

void add_variable (double x)
 Add a value. More...
 
void ClearData ()
 Clears the data. More...
 
double get_meanvalue ()
 Returns the mean. More...
 
double get_N ()
 Returns the number of values. More...
 
double get_Total ()
 Returns the mean. More...
 
double get_varianceP ()
 Returns the population variance. More...
 
double get_varianceS ()
 Returns the sample variance. More...
 
void remove_variable (double x)
 Remove a value. More...
 
 SimpleStatistics ()
 SimpleStatistics constructor. More...
 

Protected Attributes

double m_K
 
double m_n
 
double m_Sum
 
double m_SumX
 
double m_SumX2
 

Constructor & Destructor Documentation

SimpleStatistics::SimpleStatistics ( )
inline

SimpleStatistics constructor.

334  {
335  ClearData();
336  }
void ClearData()
Clears the data.
Definition: PopulationManager.h:382

Member Function Documentation

void SimpleStatistics::add_variable ( double  x)
inline

Add a value.

338  {
339  // This uses the computed shifted data equation.
340  if (m_n == 0) m_K = x;
341  m_n++;
342  m_Sum += x;
343  m_SumX += x - m_K;
344  m_SumX2 += (x - m_K) * (x - m_K);
345  }
double m_Sum
Definition: PopulationManager.h:328
double m_K
Definition: PopulationManager.h:326
double m_SumX
Definition: PopulationManager.h:329
double m_n
Definition: PopulationManager.h:327
double m_SumX2
Definition: PopulationManager.h:330
void SimpleStatistics::ClearData ( )
inline

Clears the data.

383  {
384  m_K = 0;
385  m_n = 0;
386  m_Sum = 0;
387  m_SumX = 0;
388  m_SumX2 = 0;
389  }
double m_Sum
Definition: PopulationManager.h:328
double m_K
Definition: PopulationManager.h:326
double m_SumX
Definition: PopulationManager.h:329
double m_n
Definition: PopulationManager.h:327
double m_SumX2
Definition: PopulationManager.h:330
double SimpleStatistics::get_meanvalue ( )
inline

Returns the mean.

362  {
363  return m_K + m_SumX / m_n;
364  }
double m_K
Definition: PopulationManager.h:326
double m_SumX
Definition: PopulationManager.h:329
double m_n
Definition: PopulationManager.h:327
double SimpleStatistics::get_N ( )
inline

Returns the number of values.

354  {
355  return m_n;
356  }
double m_n
Definition: PopulationManager.h:327
double SimpleStatistics::get_Total ( )
inline

Returns the mean.

358  {
359  return m_Sum;
360  }
double m_Sum
Definition: PopulationManager.h:328
double SimpleStatistics::get_varianceP ( )
inline

Returns the population variance.

366  {
367  if (m_n < 2)
368  {
369  return -1; // Ilegal n value, but don't want to exit
370  }
371  return (m_SumX2 - (m_SumX*m_SumX) / m_n) / (m_n);
372  }
double m_SumX
Definition: PopulationManager.h:329
double m_n
Definition: PopulationManager.h:327
double m_SumX2
Definition: PopulationManager.h:330
double SimpleStatistics::get_varianceS ( )
inline

Returns the sample variance.

374  {
375  if (m_n < 2)
376  {
377  return -1; // Ilegal n value, but don't want to exit
378  }
379  return (m_SumX2 - (m_SumX*m_SumX) / m_n) / (m_n - 1);
380  }
double m_SumX
Definition: PopulationManager.h:329
double m_n
Definition: PopulationManager.h:327
double m_SumX2
Definition: PopulationManager.h:330
void SimpleStatistics::remove_variable ( double  x)
inline

Remove a value.

347  {
348  m_n--;
349  m_Sum -= x;
350  m_SumX -= (x - m_K);
351  m_SumX2 -= (x - m_K) * (x - m_K);
352  }
double m_Sum
Definition: PopulationManager.h:328
double m_K
Definition: PopulationManager.h:326
double m_SumX
Definition: PopulationManager.h:329
double m_n
Definition: PopulationManager.h:327
double m_SumX2
Definition: PopulationManager.h:330

Member Data Documentation

double SimpleStatistics::m_K
protected

This class is designed to provide the facility to create simple stats from data that comes in incrementally. It can provide the mean, variance of the data set at any point in time

double SimpleStatistics::m_n
protected
double SimpleStatistics::m_Sum
protected
double SimpleStatistics::m_SumX
protected
double SimpleStatistics::m_SumX2
protected

The documentation for this class was generated from the following file: