AutoPas  3.0.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
autopas::TuningResultLogger Class Reference

Helper to log results of the tuning process to a csv file for easier analysis. More...

#include <TuningResultLogger.h>

Public Member Functions

 TuningResultLogger (const std::string &outputSuffix="")
 Constructor initializes the logger and sets the output file name.
 
 ~TuningResultLogger ()
 Destructor drops the logger from the spd registry.
 
void logTuningResult (const autopas::Configuration &configuration, size_t iteration, long timeTuning, long optimumPerformance) const
 Log the result of a tuning phase.
 

Detailed Description

Helper to log results of the tuning process to a csv file for easier analysis.

It uses an asynchronous spd logger to write a csv file named "AutoPas_iterationPerformance_<dateStamp>.csv".

By default logging the data is disabled. It can be enabled by setting the cmake variable AUTOPAS_LOG_TUNINGRESULTS to ON.

Constructor & Destructor Documentation

◆ TuningResultLogger()

autopas::TuningResultLogger::TuningResultLogger ( const std::string &  outputSuffix = "")
explicit

Constructor initializes the logger and sets the output file name.

Parameters
outputSuffixSuffix for all output files produced by this class.

Member Function Documentation

◆ logTuningResult()

void autopas::TuningResultLogger::logTuningResult ( const autopas::Configuration configuration,
size_t  iteration,
long  timeTuning,
long  optimumPerformance 
) const

Log the result of a tuning phase.

Parameters
configuration
iteration
timeTuning
optimumPerformancePerformance of the best configuration

The documentation for this class was generated from the following files: