ktt::StopCondition Class Reference

#include <StopCondition.h>

Inheritance diagram for ktt::StopCondition:

Public Member Functions
virtual	~StopCondition ()=default
virtual bool	IsFulfilled () const =0
virtual void	Initialize (const uint64_t configurationsCount)=0
virtual void	Update (const KernelResult &result)=0
virtual std::string	GetStatusString () const =0

Detailed Description

Class which can be used to stop the tuning process when certain condition is satisfied.

Constructor & Destructor Documentation

~StopCondition()

ktt::StopCondition::~StopCondition ( )

virtualdefault

Stop condition destructor. Inheriting class can override destructor with custom implementation. Default implementation is provided by KTT framework.

Member Function Documentation

GetStatusString()

std::string ktt::StopCondition::GetStatusString ( ) const

pure virtual

Returns stop condition status string. Used for logging.

Returns

Stop condition status string.

Implemented in ktt::ConfigurationCount, ktt::ConfigurationDuration, ktt::ConfigurationFraction, ktt::FailureCount, ktt::FailureFraction, ktt::TuningDuration, and ktt::UnionCondition.

Initialize()

void ktt::StopCondition::Initialize ( const uint64_t  configurationsCount )

pure virtual

Performs initialization of stop condition. Called right before the tuning process begins.

Parameters

configurationsCount

Total count of generated configurations for the tuned kernel.

Implemented in ktt::ConfigurationCount, ktt::ConfigurationDuration, ktt::ConfigurationFraction, ktt::FailureCount, ktt::FailureFraction, ktt::TuningDuration, and ktt::UnionCondition.

IsFulfilled()

bool ktt::StopCondition::IsFulfilled ( ) const

pure virtual

Checks whether stop condition is fulfilled.

Returns

True if stop condition is fulfilled, false otherwise.

Implemented in ktt::ConfigurationCount, ktt::ConfigurationDuration, ktt::ConfigurationFraction, ktt::FailureCount, ktt::FailureFraction, ktt::TuningDuration, and ktt::UnionCondition.

Update()

void ktt::StopCondition::Update ( const KernelResult &  result )

pure virtual

Performs update of stop condition. Called after each tested configuration.

Parameters

result

Result from the last tested configuration. See KernelResult for more information.

Implemented in ktt::ConfigurationCount, ktt::ConfigurationDuration, ktt::ConfigurationFraction, ktt::FailureCount, ktt::FailureFraction, ktt::TuningDuration, and ktt::UnionCondition.

---

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

• Source/Api/StopCondition/StopCondition.h