evolution_summary.h

Go to the documentation of this file.

 
#if !defined(ULTRA_EVOLUTION_SUMMARY_H)
#define      ULTRA_EVOLUTION_SUMMARY_H
 
#include <chrono>
 
#include "kernel/analyzer.h"
#include "kernel/evolution_callbacks.h"
#include "kernel/evolution_status.h"
 
namespace ultra
{
/// A summary of information about evolution (results, statistics...).
///
/// Part of the information (`status`) supports concurrent access and is keep
/// up to date while evolution is ongoing; the remaining part is calculated at
/// the end of evolution.
///
template<Individual I, Fitness F>
class summary
{
public:
  // ---- Member types ----
  using on_new_best_callback_t = ultra::on_new_best_callback_t<I, F>;
 
  // --- Constructor and support functions ---
  summary() = default;
 
  void clear();
 
  [[nodiscard]] evolution_status<I, F> starting_status();
  summary &on_new_best(on_new_best_callback_t);
 
  void set_best_fitness(F);
 
  // --- Concurrency aware functions ---
  bool update_if_better(scored_individual<I, F>);
  [[nodiscard]] scored_individual<I, F> best() const;
  [[nodiscard]] unsigned last_improvement() const;
  [[nodiscard]] unsigned stagnation() const;
 
  // --- Serialization ---
  [[nodiscard]] bool load(std::istream &, const problem &);
  [[nodiscard]] bool save(std::ostream &) const;
 
  // --- Data members ---
  analyzer<I, F> az {};

  std::chrono::milliseconds elapsed {0};

  unsigned generation {0};
 
private:
  mutable ignore_copy<std::shared_mutex> mutex_ {};
  struct data
  {
    scored_individual<I, F> best {};
    unsigned last_improvement {0};
  };
 
  [[nodiscard]] data data_snapshot() const;
 
  data data_ {};
 
  on_new_best_callback_t on_new_best_callback_ {};
};
 
#include "kernel/evolution_summary.tcc"
 
}  // namespace ultra
 
#endif  // include guard