A generic class for statistical accumulation. It uses the timemory math overloads to enable statistics for containers such as std::vector<double>, etc. More...

#include "timemory/data/statistics.hpp"

Collaboration diagram for tim::statistics< Tp >:

Public Types
using	value_type = Tp

using	this_type = statistics< Tp >

using	compute_type = math::compute< Tp, Tp >

template<typename Vp >
using	compute_value_t = math::compute< Tp, Vp >

Public Member Functions
	statistics ()=default

	~statistics ()=default

	statistics (const statistics &)=default

	statistics (statistics &&) noexcept=default

statistics &	operator= (const statistics &)=default

statistics &	operator= (statistics &&) noexcept=default

	statistics (const value_type &val)

	statistics (value_type &&val)

statistics &	operator= (const value_type &val)

int64_t	get_count () const

const value_type &	get_min () const

const value_type &	get_max () const

const value_type &	get_sum () const

const value_type &	get_sqr () const

value_type	get_mean () const

value_type	get_variance () const

value_type	get_stddev () const

void	reset ()

statistics &	operator+= (const value_type &val)

statistics &	operator-= (const value_type &val)

statistics &	operator*= (const value_type &val)

statistics &	operator/= (const value_type &val)

statistics &	operator+= (const statistics &rhs)

statistics &	operator-= (const statistics &rhs)

template<typename Archive >
void	save (Archive &ar, const unsigned int) const

template<typename Archive >
void	load (Archive &ar, const unsigned int)

Friends
std::ostream &	operator<< (std::ostream &os, const statistics &obj)

statistics	operator+ (const statistics &lhs, const statistics &rhs)

statistics	operator- (const statistics &lhs, const statistics &rhs)

Detailed Description

template<typename Tp>
struct tim::statistics< Tp >

A generic class for statistical accumulation. It uses the timemory math overloads to enable statistics for containers such as std::vector<double>, etc.

Template Parameters

Tp	data type for statistical accumulation

Definition at line 82 of file statistics.hpp.

Member Typedef Documentation

◆ compute_type

template<typename Tp >

using tim::statistics< Tp >::compute_type = math::compute<Tp, Tp>

Definition at line 87 of file statistics.hpp.

◆ compute_value_t

template<typename Tp >

template<typename Vp >

using tim::statistics< Tp >::compute_value_t = math::compute<Tp, Vp>

Definition at line 89 of file statistics.hpp.

◆ this_type

template<typename Tp >

using tim::statistics< Tp >::this_type = statistics<Tp>

Definition at line 86 of file statistics.hpp.

◆ value_type

template<typename Tp >

using tim::statistics< Tp >::value_type = Tp

Definition at line 85 of file statistics.hpp.

Constructor & Destructor Documentation

◆ statistics() [1/5]

template<typename Tp >

tim::statistics< Tp >::statistics ( )

inlinedefault

◆ ~statistics()

template<typename Tp >

tim::statistics< Tp >::~statistics ( )

inlinedefault

◆ statistics() [2/5]

template<typename Tp >

tim::statistics< Tp >::statistics ( const statistics< Tp > & )

inlinedefault

◆ statistics() [3/5]

template<typename Tp >

tim::statistics< Tp >::statistics ( statistics< Tp > && )

inlinedefaultnoexcept

◆ statistics() [4/5]

template<typename Tp >

tim::statistics< Tp >::statistics ( const value_type & val )

inlineexplicit

Definition at line 99 of file statistics.hpp.

    : m_cnt(1)
    , m_sum(val)
    , m_sqr(compute_type::sqr(val))
    , m_min(val)
    , m_max(val)
    {}

◆ statistics() [5/5]

template<typename Tp >

tim::statistics< Tp >::statistics ( value_type && val )

inlineexplicit

Definition at line 107 of file statistics.hpp.

    : m_cnt(1)
    , m_sum(std::move(val))
    , m_sqr(compute_type::sqr(m_sum))
    , m_min(m_sum)
    , m_max(m_sum)
    {}

Member Function Documentation

◆ get_count()

template<typename Tp >

int64_t tim::statistics< Tp >::get_count ( ) const

inline

Definition at line 127 of file statistics.hpp.

127{ return m_cnt; }

◆ get_max()

template<typename Tp >

const value_type & tim::statistics< Tp >::get_max ( ) const

inline

Definition at line 129 of file statistics.hpp.

129{ return m_max; }

Referenced by std::max().

◆ get_mean()

template<typename Tp >

value_type tim::statistics< Tp >::get_mean ( ) const

inline

Definition at line 132 of file statistics.hpp.

132{ return m_sum / m_cnt; }

Referenced by tim::statistics< Tp >::save().

◆ get_min()

template<typename Tp >

const value_type & tim::statistics< Tp >::get_min ( ) const

inline

Definition at line 128 of file statistics.hpp.

128{ return m_min; }

Referenced by std::min().

◆ get_sqr()

template<typename Tp >

const value_type & tim::statistics< Tp >::get_sqr ( ) const

inline

Definition at line 131 of file statistics.hpp.

131{ return m_sqr; }

◆ get_stddev()

template<typename Tp >

value_type tim::statistics< Tp >::get_stddev ( ) const

inline

Definition at line 156 of file statistics.hpp.

    {
        return compute_type::sqrt(compute_type::abs(get_variance()));
    }

References tim::math::compute< Tp, Up >::abs(), tim::statistics< Tp >::get_variance(), and tim::math::compute< Tp, Up >::sqrt().

Referenced by tim::statistics< Tp >::save().

◆ get_sum()

template<typename Tp >

const value_type & tim::statistics< Tp >::get_sum ( ) const

inline

Definition at line 130 of file statistics.hpp.

130{ return m_sum; }

◆ get_variance()

template<typename Tp >

value_type tim::statistics< Tp >::get_variance ( ) const

inline

Definition at line 133 of file statistics.hpp.

    {
        if(m_cnt < 2)
        {
            auto ret = m_sum;
            compute_type::minus(ret, m_sum);
            return ret;
        }
 
        auto _sum = m_sum;
        auto _sqr = m_sqr;
 
        // lambda for equation clarity (will be inlined)
        auto compute_variance = [&]() {
            compute_type::multiply(_sum, m_sum);
            _sum /= m_cnt;
            compute_type::minus(_sqr, _sum);
            _sqr /= (m_cnt - 1);
            return _sqr;
        };
        return compute_variance();
    }

References tim::math::compute< Tp, Up >::minus(), and tim::math::compute< Tp, Up >::multiply().

Referenced by tim::statistics< Tp >::get_stddev().

◆ load()

template<typename Tp >

template<typename Archive >

void tim::statistics< Tp >::load	(	Archive &	ar,
		const unsigned int
	)

inline

Definition at line 302 of file statistics.hpp.

    {
        ar(cereal::make_nvp("sum", m_sum), cereal::make_nvp("min", m_min),
           cereal::make_nvp("max", m_max), cereal::make_nvp("sqr", m_sqr),
           cereal::make_nvp("count", m_cnt));
    }

◆ operator*=()

template<typename Tp >

statistics & tim::statistics< Tp >::operator*= ( const value_type & val )

inline

Definition at line 205 of file statistics.hpp.

    {
        compute_type::multiply(m_sum, val);
        compute_type::multiply(m_sqr, compute_type::sqr(val));
        compute_type::multiply(m_min, val);
        compute_type::multiply(m_max, val);
        return *this;
    }

References tim::math::compute< Tp, Up >::multiply(), and tim::math::compute< Tp, Up >::sqr().

◆ operator+=() [1/2]

template<typename Tp >

statistics & tim::statistics< Tp >::operator+= ( const statistics< Tp > & rhs )

inline

Definition at line 225 of file statistics.hpp.

    {
        if(m_cnt == 0)
        {
            m_sum = rhs.m_sum;
            m_sqr = rhs.m_sqr;
            m_min = rhs.m_min;
            m_max = rhs.m_max;
        }
        else
        {
            compute_type::plus(m_sum, rhs.m_sum);
            compute_type::plus(m_sqr, rhs.m_sqr);
            m_min = compute_type::min(m_min, rhs.m_min);
            m_max = compute_type::max(m_max, rhs.m_max);
        }
        m_cnt += rhs.m_cnt;
        return *this;
    }

References tim::math::compute< Tp, Up >::max(), tim::math::compute< Tp, Up >::min(), and tim::math::compute< Tp, Up >::plus().

◆ operator+=() [2/2]

template<typename Tp >

statistics & tim::statistics< Tp >::operator+= ( const value_type & val )

inline

Definition at line 173 of file statistics.hpp.

    {
        if(m_cnt == 0)
        {
            m_sum = val;
            m_sqr = compute_type::sqr(val);
            m_min = val;
            m_max = val;
        }
        else
        {
            compute_type::plus(m_sum, val);
            compute_type::plus(m_sqr, compute_type::sqr(val));
            m_min = compute_type::min(m_min, val);
            m_max = compute_type::max(m_max, val);
        }
        ++m_cnt;
 
        return *this;
    }

References tim::math::compute< Tp, Up >::max(), tim::math::compute< Tp, Up >::min(), tim::math::compute< Tp, Up >::plus(), and tim::math::compute< Tp, Up >::sqr().

◆ operator-=() [1/2]

template<typename Tp >

statistics & tim::statistics< Tp >::operator-= ( const statistics< Tp > & rhs )

inline

Definition at line 246 of file statistics.hpp.

    {
        if(m_cnt > 0)
        {
            compute_type::minus(m_sum, rhs.m_sum);
            compute_type::minus(m_sqr, rhs.m_sqr);
            m_min = compute_type::min(m_min, rhs.m_min);
            m_max = compute_type::max(m_max, rhs.m_max);
            // m_cnt += std::abs(m_cnt - rhs.m_cnt);
        }
        return *this;
    }

References tim::math::compute< Tp, Up >::max(), tim::math::compute< Tp, Up >::min(), and tim::math::compute< Tp, Up >::minus().

◆ operator-=() [2/2]

template<typename Tp >

statistics & tim::statistics< Tp >::operator-= ( const value_type & val )

inline

Definition at line 194 of file statistics.hpp.

    {
        if(m_cnt > 1)
            --m_cnt;
        compute_type::minus(m_sum, val);
        compute_type::minus(m_sqr, compute_type::sqr(val));
        compute_type::minus(m_min, val);
        compute_type::minus(m_max, val);
        return *this;
    }

References tim::math::compute< Tp, Up >::minus(), and tim::math::compute< Tp, Up >::sqr().

◆ operator/=()

template<typename Tp >

statistics & tim::statistics< Tp >::operator/= ( const value_type & val )

inline

Definition at line 214 of file statistics.hpp.

    {
        compute_type::divide(m_sum, val);
        compute_type::divide(m_sqr, compute_type::sqr(val));
        compute_type::divide(m_min, val);
        compute_type::divide(m_max, val);
        return *this;
    }

References tim::math::compute< Tp, Up >::divide(), and tim::math::compute< Tp, Up >::sqr().

◆ operator=() [1/3]

template<typename Tp >

statistics & tim::statistics< Tp >::operator= ( const statistics< Tp > & )

inlinedefault

◆ operator=() [2/3]

template<typename Tp >

statistics & tim::statistics< Tp >::operator= ( const value_type & val )

inline

Definition at line 115 of file statistics.hpp.

    {
        m_cnt = 1;
        m_sum = val;
        m_min = val;
        m_max = val;
        m_sqr = compute_type::sqr(val);
        return *this;
    }

References tim::math::compute< Tp, Up >::sqr().

◆ operator=() [3/3]

template<typename Tp >

statistics & tim::statistics< Tp >::operator= ( statistics< Tp > && )

inlinedefaultnoexcept

◆ reset()

template<typename Tp >

void tim::statistics< Tp >::reset ( )

inline

Definition at line 162 of file statistics.hpp.

    {
        m_cnt = 0;
        m_sum = value_type{};
        m_sqr = value_type{};
        m_min = value_type{};
        m_max = value_type{};
    }

◆ save()

template<typename Tp >

template<typename Archive >

void tim::statistics< Tp >::save	(	Archive &	ar,
		const unsigned int
	)		const

inline

Definition at line 292 of file statistics.hpp.

    {
        auto _mean = (m_cnt > 0) ? get_mean() : value_type{};
        ar(cereal::make_nvp("sum", m_sum), cereal::make_nvp("count", m_cnt),
           cereal::make_nvp("min", m_min), cereal::make_nvp("max", m_max),
           cereal::make_nvp("sqr", m_sqr), cereal::make_nvp("mean", _mean),
           cereal::make_nvp("stddev", get_stddev()));
    }

References tim::statistics< Tp >::get_mean(), and tim::statistics< Tp >::get_stddev().

Friends And Related Function Documentation

◆ operator+

template<typename Tp >

statistics operator+	(	const statistics< Tp > &	lhs,
		const statistics< Tp > &	rhs
	)

friend

Definition at line 281 of file statistics.hpp.

    {
        return statistics(lhs) += rhs;
    }

◆ operator-

template<typename Tp >

statistics operator-	(	const statistics< Tp > &	lhs,
		const statistics< Tp > &	rhs
	)

friend

Definition at line 286 of file statistics.hpp.

    {
        return statistics(lhs) -= rhs;
    }

◆ operator<<

template<typename Tp >

std::ostream & operator<<	(	std::ostream &	os,
		const statistics< Tp > &	obj
	)

friend

Definition at line 269 of file statistics.hpp.

    {
        using namespace tim::stl::ostream;
        auto _mean = (obj.get_count() > 0) ? obj.get_mean() : value_type{};
        os << "[sum: " << obj.get_sum() << "] [mean: " << _mean
           << "] [min: " << obj.get_min() << "] [max: " << obj.get_max()
           << "] [var: " << obj.get_variance() << "] [stddev: " << obj.get_stddev()
           << "] [count: " << obj.get_count() << "]";
        return os;
    }

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

timemory/data/statistics.hpp

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ compute_type

◆ compute_value_t

◆ this_type

◆ value_type

Constructor & Destructor Documentation

◆ statistics() [1/5]

◆ ~statistics()

◆ statistics() [2/5]

◆ statistics() [3/5]

◆ statistics() [4/5]

◆ statistics() [5/5]

Member Function Documentation

◆ get_count()

◆ get_max()

◆ get_mean()

◆ get_min()

◆ get_sqr()

◆ get_stddev()

◆ get_sum()

◆ get_variance()

◆ load()

◆ operator*=()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ reset()

◆ save()

Friends And Related Function Documentation

◆ operator+

◆ operator-

◆ operator<<