autopas::TuningStrategyLogger Class Reference

This dummy strategy logs any call made to the list of strategies. More...

#include <TuningStrategyLogger.h>

Inheritance diagram for autopas::TuningStrategyLogger:

Collaboration diagram for autopas::TuningStrategyLogger:

Public Member Functions
	TuningStrategyLogger (const std::string &outputSuffix)
	Creates a wrapper logger for a tuning strategy.
TuningStrategyOption	getOptionType () const override
	Get this object's associated TuningStrategyOption type.
void	addEvidence (const Configuration &configuration, const Evidence &evidence) override
	Notifies the strategy about empirically collected information for the given configuration.
bool	optimizeSuggestions (std::vector< Configuration > &configQueue, const EvidenceCollection &evidenceCollection) override
	Optimizes the queue of configurations to process.
bool	reset (size_t iteration, size_t tuningPhase, std::vector< Configuration > &configQueue, const autopas::EvidenceCollection &evidenceCollection) override
	Reset all internal parameters to the beginning of a new tuning phase.
bool	needsLiveInfo () const override
	Returns whether this tuning strategy wants to get a LiveInfo object passed before a new tuning phase.
void	receiveLiveInfo (const LiveInfo &info) override
	Virtual method that subclasses can override to receive the LiveInfo object before a tuning phase if they return true in needsLiveInfo().
Public Member Functions inherited from autopas::TuningStrategyInterface
virtual TuningStrategyOption	getOptionType () const =0
	Get this object's associated TuningStrategyOption type.
virtual void	addEvidence (const Configuration &configuration, const Evidence &evidence)
	Notifies the strategy about empirically collected information for the given configuration.
virtual bool	optimizeSuggestions (std::vector< Configuration > &configQueue, const EvidenceCollection &evidenceCollection)=0
	Optimizes the queue of configurations to process.
virtual bool	reset (size_t iteration, size_t tuningPhase, std::vector< Configuration > &configQueue, const autopas::EvidenceCollection &evidenceCollection)=0
	Reset all internal parameters to the beginning of a new tuning phase.
virtual bool	needsLiveInfo () const
	Returns whether this tuning strategy wants to get a LiveInfo object passed before a new tuning phase.
virtual void	receiveLiveInfo (const LiveInfo &info)
	Virtual method that subclasses can override to receive the LiveInfo object before a tuning phase if they return true in needsLiveInfo().
virtual void	rejectConfiguration (const Configuration &configuration, bool indefinitely)
	Notify the strategy about a configuration that is (currently) invalid and thus can potentially be dropped from some internal storage.
virtual bool	needsSmoothedHomogeneityAndMaxDensity () const
	Indicate whether the strategy needs smoothed values of homogeneity and max density.
virtual void	receiveSmoothedHomogeneityAndMaxDensity (double homogeneity, double maxDensity)
	Method to pass smoothed homogeneity and the maximal density to the tuning strategy.

Detailed Description

This dummy strategy logs any call made to the list of strategies.

All methods only invoke a logger and do nothing else.

The log can be replayed using the TuningStrategyLogReplayer.

Constructor & Destructor Documentation

TuningStrategyLogger()

autopas::TuningStrategyLogger::TuningStrategyLogger ( const std::string &  outputSuffix )

explicit

Creates a wrapper logger for a tuning strategy.

Parameters

outputSuffix

The output suffix for all written log files.

Member Function Documentation

addEvidence()

void autopas::TuningStrategyLogger::addEvidence ( const Configuration &  configuration, const Evidence &  evidence  )

overridevirtual

Notifies the strategy about empirically collected information for the given configuration.

All evidence is stored centrally in the AutoTuner and its EvidenceCollection is passed to the tuning strategies during optimization.

Implementing this function is only necessary if the tuning strategy processes evidence differently than EvidenceCollection.

Parameters

configuration	Configuration used to obtain the evidence.
evidence	Measurement and when it was taken.

Reimplemented from autopas::TuningStrategyInterface.

getOptionType()

TuningStrategyOption autopas::TuningStrategyLogger::getOptionType ( ) const

overridevirtual

Get this object's associated TuningStrategyOption type.

Returns

TuningStrategyOption

Implements autopas::TuningStrategyInterface.

needsLiveInfo()

bool autopas::TuningStrategyLogger::needsLiveInfo ( ) const

overridevirtual

Returns whether this tuning strategy wants to get a LiveInfo object passed before a new tuning phase.

Returns

True, if this tuning strategy wants a LiveInfo object passed before a new tuning phase via receiveLiveInfo().

Reimplemented from autopas::TuningStrategyInterface.

optimizeSuggestions()

bool autopas::TuningStrategyLogger::optimizeSuggestions ( std::vector< Configuration > &  configQueue, const EvidenceCollection &  evidenceCollection  )

overridevirtual

Optimizes the queue of configurations to process.

This function is called once before each iteration in a tuning phase so all tuning strategies can give their input on which configuration to try next. This is done by reordering configQueue so that the next configuration to try is at the end (FIFO).

Parameters

configQueue	Queue of configurations to be tested. The tuning strategy should edit this queue.
evidenceCollection	All collected evidence until now.

Returns

boolean value to signal if the tuning strategy has intentionally wiped the config queue

Implements autopas::TuningStrategyInterface.

receiveLiveInfo()

void autopas::TuningStrategyLogger::receiveLiveInfo ( const LiveInfo &  info )

overridevirtual

Virtual method that subclasses can override to receive the LiveInfo object before a tuning phase if they return true in needsLiveInfo().

Parameters

info	A new LiveInfo object that has already gathered its information.

Reimplemented from autopas::TuningStrategyInterface.

reset()

bool autopas::TuningStrategyLogger::reset ( size_t  iteration, size_t  tuningPhase, std::vector< Configuration > &  configQueue, const autopas::EvidenceCollection &  evidenceCollection  )

overridevirtual

Reset all internal parameters to the beginning of a new tuning phase.

This can also mean to reorder the configQueue to some initially expected state.

Parameters

iteration	Gives the current iteration to the tuning strategy.
tuningPhase	Gives the current tuning phase to the tuning strategy.
configQueue	Queue of configurations to be tested. The tuning strategy should edit this queue.
evidenceCollection	All collected evidence until now.

Returns

boolean value to signal if the tuning strategy has intentionally wiped the config queue

Implements autopas::TuningStrategyInterface.

---

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

• autopas/tuning/tuningStrategy/TuningStrategyLogger.h
• autopas/tuning/tuningStrategy/TuningStrategyLogger.cpp