ref:main
/**
* @file src/stat_trackers.h
* @brief Declarations for streaming statistic tracking.
*/
#pragma once
// standard includes
#include <algorithm>
#include <chrono>
#include <cstdint>
#include <functional>
#include <limits>
// lib includes
#include <boost/format.hpp>
namespace stat_trackers {
/**
* @brief Create a formatter for values with one digit after the decimal point.
*
* @return Boost format configured for one fractional digit.
*/
boost::format one_digit_after_decimal();
/**
* @brief Create a formatter for values with two digits after the decimal point.
*
* @return Boost format configured for two fractional digits.
*/
boost::format two_digits_after_decimal();
/**
* @brief Accumulates minimum, maximum, and average values between periodic callbacks.
*/
template<typename T>
class min_max_avg_tracker {
public:
/**
* @brief Callback invoked with the minimum, maximum, and average for one interval.
*/
using callback_function = std::function<void(T stat_min, T stat_max, double stat_avg)>;
/**
* @brief Add one statistic sample and invoke the callback when the interval elapses.
*
* @param stat Statistic value used to update the tracker.
* @param callback Callback invoked with the calculated statistic.
* @param interval_in_seconds Minimum time between callback invocations.
*/
void collect_and_callback_on_interval(T stat, const callback_function &callback, std::chrono::seconds interval_in_seconds) {
if (data.calls == 0) {
data.last_callback_time = std::chrono::steady_clock::now();
} else if (std::chrono::steady_clock::now() > data.last_callback_time + interval_in_seconds) {
callback(data.stat_min, data.stat_max, data.stat_total / data.calls);
data = {};
}
data.stat_min = std::min(data.stat_min, stat);
data.stat_max = std::max(data.stat_max, stat);
data.stat_total += stat;
data.calls += 1;
}
/**
* @brief Reset the object to its initial empty state.
*/
void reset() {
data = {};
}
private:
struct {
std::chrono::steady_clock::time_point last_callback_time = std::chrono::steady_clock::now();
T stat_min = std::numeric_limits<T>::max();
T stat_max = std::numeric_limits<T>::lowest();
double stat_total = 0;
uint32_t calls = 0;
} data;
};
} // namespace stat_trackers