autopas::EvidenceCollection Class Reference

Class to manage all evidence. More...

#include <EvidenceCollection.h>

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 >	getOptimalConfiguration (size_t tuningPhase) 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 () 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

(

)

const

Report if there is any evidence in the collection.

Returns

True if there is no evidence in the collection.

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

)

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.

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