distribution.h

Go to the documentation of this file.

 
#if !defined(ULTRA_DISTRIBUTION_H)
#define      ULTRA_DISTRIBUTION_H
 
#include "utility/assert.h"
#include "utility/log.h"
#include "utility/misc.h"
 
#include <algorithm>
#include <cmath>
#include <iomanip>
#include <iosfwd>
#include <map>
#include <ranges>
 
namespace ultra
{

template<ArithmeticFloatingType T>
class distribution
{
public:
  distribution() = default;
 
  void clear();
 
  void add(T);
 
  [[nodiscard]] bool empty() const noexcept;
  [[nodiscard]] std::size_t size() const noexcept;
  [[nodiscard]] double entropy() const;
  [[nodiscard]] T max() const noexcept;
  [[nodiscard]] T mean() const noexcept;
  [[nodiscard]] T min() const noexcept;
  [[nodiscard]] const std::map<T, std::uintmax_t> &seen() const;
  [[nodiscard]] T standard_deviation() const;
  [[nodiscard]] T variance() const;
 
  void merge(const distribution<T> &);
 
  [[nodiscard]] bool is_valid() const;
 
  // ---- Serialization ----
  bool load(std::istream &);
  bool save(std::ostream &) const;
 
private:
  // ---- Private member functions ----
  void update_variance(T);
 
  // ---- Private data members ----
  std::map<T, std::uintmax_t> seen_ {};
 
  T m2_ {};
  T m2_comp_ {};    // Kahan compensation
  T mean_ {};
  T mean_comp_ {};  // Kahan compensation
  T max_ {};
  T min_ {};
 
  std::size_t size_ {0};
};
 
#include "kernel/distribution.tcc"
}  // namespace ultra
 
#endif  // include guard