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

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

#include <TuningDataLogger.h>

Public Member Functions

 TuningDataLogger (size_t numSamples, const std::string &outputSuffix="")
 Constructor initializes the logger and sets the output file name.
 
 ~TuningDataLogger ()
 Destructor drops the logger from the spd registry.
 
void logTuningData (const autopas::Configuration &configuration, const std::vector< long > &samplesRebuildingNeighborLists, const std::vector< long > &samplesNotRebuildingNeighborLists, size_t iteration, long reducedValue, long smoothedVale, double meanRebuildFrequency) 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_TUNINGDATA to ON.

Constructor & Destructor Documentation

◆ TuningDataLogger()

autopas::TuningDataLogger::TuningDataLogger ( size_t  numSamples,
const std::string &  outputSuffix = "" 
)
explicit

Constructor initializes the logger and sets the output file name.

Parameters
numSamplesNumber of samples that are taken per configuration.
outputSuffixSuffix for all output files produced by this class.

Member Function Documentation

◆ logTuningData()

void autopas::TuningDataLogger::logTuningData ( const autopas::Configuration configuration,
const std::vector< long > &  samplesRebuildingNeighborLists,
const std::vector< long > &  samplesNotRebuildingNeighborLists,
size_t  iteration,
long  reducedValue,
long  smoothedVale,
double  meanRebuildFrequency 
) const

Log the result of a tuning phase.

Parameters
configuration
samplesRebuildingNeighborLists
samplesNotRebuildingNeighborLists
iteration
reducedValue
smoothedVale
meanRebuildFrequency

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