executionStatistics.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2020-2025 European Southern Observatory (ESO)
//
// SPDX-License-Identifier: LGPL-3.0-only
 
// !!! We are leave this class for now but we should think and decide if we want to keep it
 
#ifndef HLCC_PFSSIMHLCC_EXECUTION_STATISTICS_HPP
#define HLCC_PFSSIMHLCC_EXECUTION_STATISTICS_HPP
 
#include<string>
#include<chrono>
#include<vector>
 
#include<boost/circular_buffer.hpp>
 
 
namespace hlcc::pfssimhlcc {
 
class ExecTimeStats {
public:
    struct StatisticsData {
        uint64_t average_ns;
        uint64_t lowest_ns;
        uint64_t highest_ns;
        uint64_t samples_nbr;
    };
 
    struct StatisticsCollection {
        std::string name;
        StatisticsData cpp_data;
        StatisticsData py_data;
    };
 
    ExecTimeStats(std::string p_name, uint16_t p_buf_size);
 
    void TimerStart();
 
    void TimerStop();
 
    std::string GetName() {return m_stats_name;};
 
    StatisticsData GetStatsData();
 
    std::string PrintStats();
 
    static std::string PrintCollection(const std::vector<StatisticsCollection> &collection);
 
    static std::string DurationAsString(uint64_t time_ns);
 
private:
    /* Name given to the current stats instance*/
    std::string m_stats_name;
    /* Buffer to store the timer data for multiple iterations */
    boost::circular_buffer<uint64_t> m_buf_elapsed_ns;
    /* Durations variables to hold the current iteration data*/
    std::chrono::nanoseconds m_start;
    std::chrono::nanoseconds m_stop;
};
 
}  // namespace hlcc::pfssimhlcc
 
 
#endif  // HLCC_PFSSIMHLCC_EXECUTION_STATISTICS_HPP