UserDefinedMeasurementTemplate.h

#pragma once


#include <celero/Statistics.h>
#include <celero/UserDefinedMeasurement.h>

#include <numeric>
#include <type_traits>

namespace celero
{
    template <typename T>
    class UserDefinedMeasurementTemplate : public UserDefinedMeasurement
    {
        static_assert(std::is_arithmetic<T>::value, "UserDefinedMeasurementTemplate requres an arithmetic type.");

    public:
        UserDefinedMeasurementTemplate() = default;

        virtual ~UserDefinedMeasurementTemplate() = default;

        UDMAggregationTable getAggregationInfo() const override
        {
            UDMAggregationTable table;

            if(this->reportSize() == true)
            {
                table.push_back({"# Samp", [this]() { return static_cast<double>(this->getStatistics().getSize()); }});
            }

            if(this->reportMean() == true)
            {
                table.push_back({"Mean", [this]() { return this->getStatistics().getMean(); }});
            }

            if(this->reportVariance() == true)
            {
                table.push_back({"Var", [this]() { return this->getStatistics().getVariance(); }});
            }

            if(this->reportStandardDeviation() == true)
            {
                table.push_back({"StdDev", [this]() { return this->getStatistics().getStandardDeviation(); }});
            }

            if(this->reportSkewness() == true)
            {
                table.push_back({"Skew", [this]() { return this->getStatistics().getSkewness(); }});
            }

            if(this->reportKurtosis() == true)
            {
                table.push_back({"Kurtosis", [this]() { return this->getStatistics().getKurtosis(); }});
            }

            if(this->reportZScore() == true)
            {
                table.push_back({"ZScore", [this]() { return this->getStatistics().getZScore(); }});
            }

            if(this->reportMin() == true)
            {
                table.push_back({"Min", [this]() { return static_cast<double>(this->getStatistics().getMin()); }});
            }

            if(this->reportMax() == true)
            {
                table.push_back({"Max", [this]() { return static_cast<double>(this->getStatistics().getMax()); }});
            }

            return table;
        }

        void addValue(T x)
        {
            this->stats.addSample(x);
        }

        void merge(const UserDefinedMeasurement* const x) override
        {
            const auto toMerge = dynamic_cast<const UserDefinedMeasurementTemplate<T>* const>(x);
            this->stats += toMerge->stats;
        }

    protected:
        virtual bool reportSize() const
        {
            return true;
        }

        virtual bool reportMean() const
        {
            return true;
        }

        virtual bool reportVariance() const
        {
            return true;
        }

        virtual bool reportStandardDeviation() const
        {
            return true;
        }

        virtual bool reportSkewness() const
        {
            return true;
        }

        virtual bool reportKurtosis() const
        {
            return true;
        }

        virtual bool reportZScore() const
        {
            return true;
        }

        virtual bool reportMin() const
        {
            return true;
        }

        virtual bool reportMax() const
        {
            return true;
        }

        const Statistics<T>& getStatistics() const
        {
            return this->stats;
        }

    private:
        Statistics<T> stats;
    };

} // namespace celero