SimpleStatistics Class Reference

#include <PopulationManager.h>

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

Protected Attributes
double	m_K {0}
double	m_n {0}
double	m_Sum {0}
double	m_SumX {0}
double	m_SumX2 {0}

Constructor & Destructor Documentation

SimpleStatistics()

SimpleStatistics::SimpleStatistics ( )

default

SimpleStatistics constructor.

Member Function Documentation

add_variable()

void SimpleStatistics::add_variable ( double  x )

inline

Add a value.

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

References m_K, m_n, m_Sum, m_SumX, and m_SumX2.

ClearData()

void SimpleStatistics::ClearData ( )

inline

Clears the data.

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

References m_K, m_n, m_Sum, m_SumX, and m_SumX2.

Referenced by Osmia_Population_Manager::DoLast().

get_meanvalue()

double SimpleStatistics::get_meanvalue ( ) const

inline

Returns the mean.

                                 {
        if (m_n < 1) return -1;
        return m_K + m_SumX / m_n;
    }

References m_K, m_n, and m_SumX.

Referenced by Osmia_Population_Manager::DoLast().

get_N()

double SimpleStatistics::get_N ( ) const

inline

Returns the number of values.

{ return m_n; }

References m_n.

Referenced by get_SE().

get_SD()

double SimpleStatistics::get_SD ( )

inline

Returns the sample standard deviation.

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

References get_varianceS(), and m_n.

get_SE()

double SimpleStatistics::get_SE ( )

inline

Returns the sample standard error.

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

References get_N(), get_varianceS(), and m_n.

get_Total()

double SimpleStatistics::get_Total ( ) const

inline

Returns the mean.

{ return m_Sum; }

References m_Sum.

get_varianceP()

double SimpleStatistics::get_varianceP ( )

inline

Returns the population variance.

                           {
        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;
    }

References m_n, m_SumX, and m_SumX2.

get_varianceS()

double SimpleStatistics::get_varianceS ( )

inline

Returns the sample variance.

                           {
        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);
    }

References m_n, m_SumX, and m_SumX2.

Referenced by get_SD(), and get_SE().

remove_variable()

void SimpleStatistics::remove_variable ( double  x )

inline

Remove a value.

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

References m_K, m_n, m_Sum, m_SumX, and m_SumX2.

Member Data Documentation

m_K

double SimpleStatistics::m_K {0}

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

Referenced by add_variable(), ClearData(), get_meanvalue(), and remove_variable().

m_n

double SimpleStatistics::m_n {0}

protected

Referenced by add_variable(), ClearData(), get_meanvalue(), get_N(), get_SD(), get_SE(), get_varianceP(), get_varianceS(), and remove_variable().

m_Sum

double SimpleStatistics::m_Sum {0}

protected

Referenced by add_variable(), ClearData(), get_Total(), and remove_variable().

m_SumX

double SimpleStatistics::m_SumX {0}

protected

Referenced by add_variable(), ClearData(), get_meanvalue(), get_varianceP(), get_varianceS(), and remove_variable().

m_SumX2

double SimpleStatistics::m_SumX2 {0}

protected

Referenced by add_variable(), ClearData(), get_varianceP(), get_varianceS(), and remove_variable().

---

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

• /builds/ALMaSS/ALMaSS_MIDox/BatchALMaSS/PopulationManager.h