search_stats.h

Go to the documentation of this file.

 
#if !defined(ULTRA_SEARCH_STATS_H)
#define      ULTRA_SEARCH_STATS_H
 
#include "kernel/distribution.h"
#include "kernel/fitness.h"
#include "kernel/individual.h"
#include "kernel/model_measurements.h"
#include "utility/misc.h"
 
#include <algorithm>
#include <chrono>
#include <cmath>
#include <functional>
#include <span>
#include <vector>
 
namespace ultra
{

///
template<Individual I, Fitness F>
class search_stats
{
public:
  struct run_summary
  {
    std::size_t run {};  // run identifier
    I best_individual {};  // best individual produced by the run
    model_measurements<F> best_measurements {};  // measurements associated
  };                                             // with the best individual
 
  void update(const I &, const model_measurements<F> &,
              std::chrono::milliseconds);
 
  [[nodiscard]] std::size_t best_run() const noexcept;
  [[nodiscard]] const I &best_individual() const noexcept;
  [[nodiscard]] std::set<std::size_t> good_runs(
    const model_measurements<F> &) const;
  [[nodiscard]] const model_measurements<F> &best_measurements() const noexcept;
  [[nodiscard]] std::size_t runs() const noexcept;
  [[nodiscard]] double success_rate(
    const model_measurements<F> &) const noexcept;
  [[nodiscard]] std::span<const run_summary> elite_runs(
    double = 0.05) const noexcept;

  distribution<F> fitness_distribution {};

  std::chrono::milliseconds elapsed {0};
 
private:
  std::vector<run_summary> stats_ {};
};
 
#include "kernel/search_stats.tcc"
}  // namespace ultra
 
#endif  // include guard