performance.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_PERFORMANCE_H
#define AJA_PERFORMANCE_H
 
// Includes
#include "ajabase/common/timer.h"
#include <string>
#include <map>
 
typedef std::map<std::string, uint64_t> AJAPerformanceExtraMap;
 
// Declarations
class AJAExport AJAPerformance
{
    public:
        AJAPerformance(const std::string& name,
                       AJATimerPrecision precision = AJATimerPrecisionMilliseconds,
                       uint64_t skipEntries = 0);
 
        AJAPerformance(const std::string& name, const AJAPerformanceExtraMap& values,
                       AJATimerPrecision precision = AJATimerPrecisionMilliseconds,
                       uint64_t skipEntries = 0);
 
        AJAPerformance(AJATimerPrecision precision = AJATimerPrecisionMilliseconds,
                       uint64_t skipEntries = 0);
 
        ~AJAPerformance(void);
 
        void SetExtras(const AJAPerformanceExtraMap& values);
 
        void Start(void);
 
        void Stop(void);
 
        void Report(const std::string& name = "", const char *pFileName = NULL, int32_t lineNumber = -1);
 
        std::string Name(void);
 
        AJATimerPrecision Precision(void);
 
        uint64_t Entries(void);
 
        uint64_t TotalTime(void);
 
        uint64_t MinTime(void);
 
        uint64_t MaxTime(void);
 
        double Mean(void);
 
        double Variance(void);
 
        double StandardDeviation(void);
 
        const AJAPerformanceExtraMap Extras(void);
 
    private:
        AJATimer                    mTimer;
        std::string                 mName;
        uint64_t                    mTotalTime;
        uint64_t                    mEntries;
        uint64_t                    mMinTime;
        uint64_t                    mMaxTime;
        double                      mMean;
        double                      mM2;
        uint64_t                    mNumEntriesToSkipAtStart;
 
        AJAPerformanceExtraMap      mExtras;
};
 
// Helper functions to track/report many performance timers and store in a map
typedef std::map<std::string, AJAPerformance> AJAPerformanceTracking;
 
extern bool AJAPerformanceTracking_start(AJAPerformanceTracking& stats,
                                        std::string key,
                                        AJATimerPrecision precision = AJATimerPrecisionMilliseconds,
                                        uint64_t skipEntries = 0);
 
extern bool AJAPerformanceTracking_start(AJAPerformanceTracking& stats,
                                        std::string key, const AJAPerformanceExtraMap& extras,
                                        AJATimerPrecision precision = AJATimerPrecisionMilliseconds,
                                        uint64_t skipEntries = 0);
 
extern bool AJAPerformanceTracking_stop(AJAPerformanceTracking& stats, std::string key);
 
extern bool AJAPerformanceTracking_report(AJAPerformanceTracking& stats, std::string title = "",
                                         const char *pFileName = NULL, int32_t lineNumber = -1);
 
 
#endif // AJA_PERFORMANCE_H