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 a certain fraction of the available training examples and labels is covered.

Subclassed by seco::CoverageStoppingCriterionConfig

Public Functions

inline virtual ~ICoverageStoppingCriterionConfig()¶

virtual float32 getMinCoverage() const = 0¶

Returns the fraction of training examples and labels that must be covered before the induction of rules is stopped.

Returns:: The fraction that must be covered before the induction of rules is stopped

virtual ICoverageStoppingCriterionConfig &setMinCoverage(float32 minCoverage) = 0¶

Sets the fraction of training examples and labels that must be covered before the induction of rules is stopped.

Parameters:: minCoverage – The fraction of training examples and labels that must be covered before the induction of rules is stopped. Must be in [0, 1)
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 a certain fraction of the available training examples and labels is covered.

Public Functions

CoverageStoppingCriterionConfig()¶

virtual float32 getMinCoverage() const override¶

Returns the fraction of training examples and labels that must be covered before the induction of rules is stopped.

Returns:: The fraction that must be covered before the induction of rules is stopped

virtual ICoverageStoppingCriterionConfig &setMinCoverage(float32 minCoverage) override¶

Sets the fraction of training examples and labels that must be covered before the induction of rules is stopped.

Parameters:: minCoverage – The fraction of training examples and labels that must be covered before the induction of rules is stopped. Must be in [0, 1)
Returns:: A reference to an object of type ICoverageStoppingCriterionConfig that allows further configuration of the stopping criterion

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