Kernel Tuning Toolkit 2.3
 
Loading...
Searching...
No Matches
ktt::FailureFraction Class Reference

#include <FailureFraction.h>

Inheritance diagram for ktt::FailureFraction:
ktt::StopCondition

Public Member Functions

 FailureFraction (const double fraction, const uint64_t minCount=0)
 
bool IsFulfilled () const override
 
void Initialize (const uint64_t configurationsCount) override
 
void Update (const KernelResult &result) override
 
std::string GetStatusString () const override
 
- Public Member Functions inherited from ktt::StopCondition
virtual ~StopCondition ()=default
 

Detailed Description

Class which implements stop condition based on fraction of failed kernel runs.

Constructor & Destructor Documentation

◆ FailureFraction()

ktt::FailureFraction::FailureFraction ( const double  fraction,
const uint64_t  minCount = 0 
)
explicit

Initializes failure fraction condition.

Parameters
fractionFraction of failed kernel runs before condition is fulfilled. The valid range of values is 0.0 - 1.0 corresponding to 0% - 100% of explored configurations.
minCountThe number of configurations that is always explored

Member Function Documentation

◆ GetStatusString()

std::string ktt::FailureFraction::GetStatusString ( ) const
overridevirtual

Returns stop condition status string. Used for logging.

Returns
Stop condition status string.

Implements ktt::StopCondition.

◆ Initialize()

void ktt::FailureFraction::Initialize ( const uint64_t  configurationsCount)
overridevirtual

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

Parameters
configurationsCountTotal count of generated configurations for the tuned kernel.

Implements ktt::StopCondition.

◆ IsFulfilled()

bool ktt::FailureFraction::IsFulfilled ( ) const
overridevirtual

Checks whether stop condition is fulfilled.

Returns
True if stop condition is fulfilled, false otherwise.

Implements ktt::StopCondition.

◆ Update()

void ktt::FailureFraction::Update ( const KernelResult result)
overridevirtual

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

Parameters
resultResult from the last tested configuration. See KernelResult for more information.

Implements ktt::StopCondition.


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