SimpleStatistics Class Reference

#include <populationmanager.h>

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

Protected Attributes
double	m_K
double	m_n
double	m_Sum
double	m_SumX
double	m_SumX2

Detailed Description

Definition at line 319 of file populationmanager.h.

Constructor & Destructor Documentation

SimpleStatistics::SimpleStatistics ( )

inline

SimpleStatistics constructor.

Definition at line 333 of file populationmanager.h.

    {
        ClearData();
    }

Member Function Documentation

void SimpleStatistics::add_variable ( double  x )

inline

Add a value.

Definition at line 338 of file populationmanager.h.

                               {
        // This uses the computed shifted data equation. 
        if (m_n == 0) m_K = x;
        m_n++;
        m_Sum += x;
        m_SumX += x - m_K;
        m_SumX2 += (x - m_K) * (x - m_K);
    }

void SimpleStatistics::ClearData ( )

inline

Clears the data.

Definition at line 382 of file populationmanager.h.

    {
        m_K = 0;
        m_n = 0;
        m_Sum = 0;
        m_SumX = 0;
        m_SumX2 = 0;
    }

double SimpleStatistics::get_meanvalue ( )

inline

Returns the mean.

Definition at line 362 of file populationmanager.h.

                          {
        return m_K + m_SumX / m_n;
    }

double SimpleStatistics::get_N ( )

inline

Returns the number of values.

Definition at line 354 of file populationmanager.h.

                  {
        return m_n;
    }

double SimpleStatistics::get_Total ( )

inline

Returns the mean.

Definition at line 358 of file populationmanager.h.

                      {
        return m_Sum;
    }

double SimpleStatistics::get_varianceP ( )

inline

Returns the population variance.

Definition at line 366 of file populationmanager.h.

                          {
        if (m_n < 2)
        {
            return -1; // Ilegal n value, but don't want to exit
        }
        return (m_SumX2 - (m_SumX*m_SumX) / m_n) / (m_n);
    }

double SimpleStatistics::get_varianceS ( )

inline

Returns the sample variance.

Definition at line 374 of file populationmanager.h.

                          {
        if (m_n < 2)
        {
            return -1; // Ilegal n value, but don't want to exit
        }
        return (m_SumX2 - (m_SumX*m_SumX) / m_n) / (m_n - 1);
    }

void SimpleStatistics::remove_variable ( double  x )

inline

Remove a value.

Definition at line 347 of file populationmanager.h.

                                  {
        m_n--;
        m_Sum -= x;
        m_SumX -= (x - m_K);
        m_SumX2 -= (x - m_K) * (x - m_K);
    }

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

Definition at line 326 of file populationmanager.h.

double SimpleStatistics::m_n

protected

Definition at line 327 of file populationmanager.h.

double SimpleStatistics::m_Sum

protected

Definition at line 328 of file populationmanager.h.

double SimpleStatistics::m_SumX

protected

Definition at line 329 of file populationmanager.h.

double SimpleStatistics::m_SumX2

protected

Definition at line 330 of file populationmanager.h.

---

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

• D:/CJT/Repos/ALMaSS_all/BatchALMaSS/populationmanager.h