File stopping_criterion_size.hpp

class ISizeStoppingCriterionConfig

#include <stopping_criterion_size.hpp>

Defines an interface for all classes that allow to configure a stopping criterion that ensures that the number of induced rules does not exceed a certain maximum.

Subclassed by SizeStoppingCriterionConfig

Public Functions

inline virtual ~ISizeStoppingCriterionConfig()

virtual uint32 getMaxRules() const = 0

Returns the maximum number of rules that are induced.

Returns:

The maximum number of rules that are induced

virtual ISizeStoppingCriterionConfig &setMaxRules(uint32 maxRules) = 0

Sets the maximum number of rules that should be induced.

Parameters:

maxRules – The maximum number of rules that should be induced. Must be at least 1

Returns:

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

class SizeStoppingCriterionConfig : public IStoppingCriterionConfig, public ISizeStoppingCriterionConfig

#include <stopping_criterion_size.hpp>

Allows to configure a stopping criterion that ensures that the number of induced rules does not exceed a certain maximum.

Public Functions

SizeStoppingCriterionConfig()

virtual uint32 getMaxRules() const override

Returns the maximum number of rules that are induced.

Returns:

The maximum number of rules that are induced

virtual ISizeStoppingCriterionConfig &setMaxRules(uint32 maxRules) override

Sets the maximum number of rules that should be induced.

Parameters:

maxRules – The maximum number of rules that should be induced. Must be at least 1

Returns:

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

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

Creates and returns a new object of type IStoppingCriterionFactory according to the specified configuration.

Returns:

An unique pointer to an object of type IStoppingCriterionFactory that has been created

Private Members

uint32 maxRules_