autopas::EvidenceCollection Class Reference

Class to manage all evidence. More...

#include <EvidenceCollection.h>

Public Types
enum	EvidenceMode { EFFECTIVE , TRAVERSAL , TOTAL }
	Helper enum to switch between evidence measurements modes.

Public Member Functions
void	addEvidence (const Configuration &configuration, const Evidence &evidence)
	Store a piece of evidence in the internal storage.
const std::vector< Evidence > *	getEvidence (const Configuration &configuration) const
	Returns all evidence collected for a given configuration.
Evidence &	modifyLastEvidence (const Configuration &configuration)
	Returns a modifiable reference to the last evidence of a given configuration.
std::tuple< Configuration, Evidence >	getBestConfigForContainerAndCSF (ContainerOption containerOption, double cellSizeFactor) const
	Retrieve the configuration with the best reduced evidence for a particular container plus cell size factor.
std::tuple< Configuration, Evidence >	getBestConfigWithRebuild () const
	Retrieve the configuration with the best total evidence.
std::tuple< Configuration, Evidence >	getOptimalConfiguration (size_t tuningPhase, EvidenceMode mode=EFFECTIVE, std::optional< ContainerOption > containerConstraint=std::nullopt, std::optional< double > csfConstraint=std::nullopt) const
	Retrieve the configuration with the lowest evidence value for the given tuning phase.
std::tuple< Configuration, Evidence >	getLatestOptimalConfiguration () const
	Retrieve the configuration with the lowest evidence value for the latest tuning phase.
bool	empty (std::optional< size_t > tuningPhase=std::nullopt) const
	Report if there is any evidence in the collection.

Detailed Description

Class to manage all evidence.

Member Function Documentation

addEvidence()

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

Store a piece of evidence in the internal storage.

Parameters

configuration
evidence

empty()

bool autopas::EvidenceCollection::empty

(

std::optional< size_t >

tuningPhase = std::nullopt

)

const

Report if there is any evidence in the collection.

Parameters

tuningPhase

Optionally pass a tuning phase to check whether there is no evidence for this particular phase.

Returns

True if there is no evidence in the collection.

getBestConfigForContainerAndCSF()

std::tuple< Configuration, Evidence > autopas::EvidenceCollection::getBestConfigForContainerAndCSF	(	ContainerOption	containerOption,
		double	cellSizeFactor
	)		const

Retrieve the configuration with the best reduced evidence for a particular container plus cell size factor.

Parameters

containerOption	The container option to limit our configurations to.
cellSizeFactor	The cellSizeFactor to limit our configurations to.

Returns

The optimal configuration and corresponding evidence

getBestConfigWithRebuild()

std::tuple< Configuration, Evidence > autopas::EvidenceCollection::getBestConfigWithRebuild

(

)

const

Retrieve the configuration with the best total evidence.

Rebuild + Traversal.

Returns

The optimal configuration and corresponding evidence

getEvidence()

const std::vector< Evidence > * autopas::EvidenceCollection::getEvidence

(

const Configuration &

configuration

)

const

Returns all evidence collected for a given configuration.

Parameters

configuration

Returns

If there is evidence a const pointer to the vector of collected evidence, otherwise nullptr.

getLatestOptimalConfiguration()

std::tuple< Configuration, Evidence > autopas::EvidenceCollection::getLatestOptimalConfiguration

(

)

const

Retrieve the configuration with the lowest evidence value for the latest tuning phase.

Returns

The optimal configuration.

getOptimalConfiguration()

std::tuple< Configuration, Evidence > autopas::EvidenceCollection::getOptimalConfiguration	(	size_t	tuningPhase,
		EvidenceMode	mode = EFFECTIVE,
		std::optional< ContainerOption >	containerConstraint = std::nullopt,
		std::optional< double >	csfConstraint = std::nullopt
	)		const

Retrieve the configuration with the lowest evidence value for the given tuning phase.

Parameters

tuningPhase	The tuning phase for which the optimum should be returned.
mode	The Evidence criterion to look at (REDUCED, TRAVERSAL or TOTAL). Default = REDUCED
containerConstraint	The container for which the optimum should be returned. Default = none
csfConstraint	The cell size factor for which the optimum should be returned. Default = none

Returns

The optimal configuration.

modifyLastEvidence()

Evidence & autopas::EvidenceCollection::modifyLastEvidence

(

const Configuration &

configuration

)

Returns a modifiable reference to the last evidence of a given configuration.

Parameters

configuration

Returns

Non-const reference to the last entry in the vector of a given configuration.

---

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

• autopas/tuning/searchSpace/EvidenceCollection.h
• autopas/tuning/searchSpace/EvidenceCollection.cpp