File rule_refinement.hpp

class IRuleRefinement
#include <rule_refinement.hpp>

Defines an interface for all classes that allow to find the best refinement of existing rules.

Subclassed by FeatureBasedRuleRefinement< IndexVector >

Public Functions

inline virtual ~IRuleRefinement()
virtual void findRefinement(SingleRefinementComparator &comparator, uint32 minCoverage) const = 0

Finds the best refinement of an existing rule.

Parameters:

  • comparator – A reference to an object of type SingleRefinementComparator that should be used for comparing potential refinements

  • minCoverage – The minimum number of examples that must be covered by the refinement

virtual void findRefinement(FixedRefinementComparator &comparator, uint32 minCoverage) const = 0

Finds the best refinements of an existing rule.

Parameters:

  • comparator – A reference to an object of type MultiRefinementComparator that should be used for comparing potential refinements

  • minCoverage – The minimum number of examples that must be covered by the refinements

class ICallback
#include <rule_refinement.hpp>

Defines an interface for callbacks that may be invoked by subclasses of the the class IRuleRefinement in order to retrieve the information that is required to search for potential refinements. It consists of IImmutableWeightedStatistics, as well as an IFeatureVector that allows to determine the thresholds that may be used by potential conditions.

Public Functions

inline virtual ~ICallback()
virtual Result get() = 0

Invokes the callback and returns its result.

Returns:

An object of type Result that stores references to the statistics and the feature vector that may be used to search for potential refinements

struct Result
#include <rule_refinement.hpp>

The data that is provided via the callback’s get function.

Public Functions

inline Result(const IImmutableWeightedStatistics &statistics, const IFeatureVector &featureVector)
Parameters:

  • statistics – A reference to an object of type IImmutableWeightedStatistics that should be used to search for potential refinements

  • featureVector – A reference to an object of type IFeatureVector that should be used to search for potential refinements

Public Members

const IImmutableWeightedStatistics &statistics

A reference to an object of type IImmutableWeightedStatistics that should be used to search for potential refinements.

const IFeatureVector &featureVector

A reference to an object of type IFeatureVector that should be used to search for potential refinements.