EvidenceCollection.h

Go to the documentation of this file.

 
#pragma once
 
#include <map>
#include <optional>
#include <string>
#include <tuple>
#include <vector>
 
#include "autopas/options/ContainerOption.h"
#include "autopas/tuning/Configuration.h"
#include "autopas/tuning/searchSpace/Evidence.h"
 
namespace autopas {
 
class EvidenceCollection {
 public:
  enum EvidenceMode {
    // Calculate the effective measurement for an average iteration
    EFFECTIVE,
    // Evidence of only the traversal measurement.
    TRAVERSAL,
    // Evidence of the rebuild + traversal measurement for a single iteration where a rebuild actually occurred.
    TOTAL
  };
 
  EvidenceCollection() = default;
 
  void addEvidence(const Configuration &configuration, const Evidence &evidence);
 
  [[nodiscard]] const std::vector<Evidence> *getEvidence(const Configuration &configuration) const;
 
  Evidence &modifyLastEvidence(const Configuration &configuration);
 
  [[nodiscard]] std::tuple<Configuration, Evidence> getBestConfigForContainerAndCSF(ContainerOption containerOption,
                                                                                    double cellSizeFactor) const;
 
  [[nodiscard]] std::tuple<Configuration, Evidence> getBestConfigWithRebuild() const;
 
  [[nodiscard]] std::tuple<Configuration, Evidence> getOptimalConfiguration(
      size_t tuningPhase, EvidenceMode mode = EFFECTIVE,
      std::optional<ContainerOption> containerConstraint = std::nullopt,
      std::optional<double> csfConstraint = std::nullopt) const;
 
  [[nodiscard]] std::tuple<Configuration, Evidence> getLatestOptimalConfiguration() const;
 
  [[nodiscard]] bool empty(std::optional<size_t> tuningPhase = std::nullopt) const;
 
 private:
  std::map<Configuration, std::vector<Evidence>> _evidenceMap{};
 
  size_t _latestTuningPhase{0};
};
 
inline std::string format_as(EvidenceCollection::EvidenceMode mode) {
  switch (mode) {
    case EvidenceCollection::EFFECTIVE:
      return "Effective";
    case EvidenceCollection::TRAVERSAL:
      return "Traversal";
    case EvidenceCollection::TOTAL:
      return "Total";
    default:
      return "UnknownEvidenceMode";
  }
}
 
}  // namespace autopas