File stopping_criterion_coverage.hpp

namespace seco
class ICoverageStoppingCriterionConfig
#include <stopping_criterion_coverage.hpp>

Defines an interface for all classes that allow to configure a stopping criterion that stops the induction of rules as soon as the sum of the weights of the uncovered labels is smaller or equal to a certain threshold.

Subclassed by seco::CoverageStoppingCriterionConfig

Public Functions

inline virtual ~ICoverageStoppingCriterionConfig()
virtual float64 getThreshold() const = 0

Returns the threshold that is used by the stopping criterion.

Returns:

The threshold that is used by the stopping criterion

virtual ICoverageStoppingCriterionConfig &setThreshold(float64 threshold) = 0

Sets the threshold that should be used by the stopping criterion.

Parameters:

threshold – The threshold that should be used by the stopping criterion. The threshold must be at least 0

Returns:

A reference to an object of type ICoverageStoppingCriterionConfig that allows further configuration of the stopping criterion

class CoverageStoppingCriterionConfig : public IStoppingCriterionConfig, public seco::ICoverageStoppingCriterionConfig
#include <stopping_criterion_coverage.hpp>

Allows to configure a stopping criterion that stops the induction of rules as soon as the sum of the weights of the uncovered labels is smaller or equal to a certain threshold.

Public Functions

CoverageStoppingCriterionConfig()
virtual float64 getThreshold() const override

Returns the threshold that is used by the stopping criterion.

Returns:

The threshold that is used by the stopping criterion

virtual ICoverageStoppingCriterionConfig &setThreshold(float64 threshold) override

Sets the threshold that should be used by the stopping criterion.

Parameters:

threshold – The threshold that should be used by the stopping criterion. The threshold must be at least 0

Returns:

A reference to an object of type ICoverageStoppingCriterionConfig that allows further configuration of the stopping criterion

std::unique_ptr<IStoppingCriterionFactory> createStoppingCriterionFactory() const override

See also

IStoppingCriterionConfig::createStoppingCriterionFactory

Private Members

float64 threshold_