File rule_evaluation.hpp

namespace seco
template<typename StatisticVector>
class IRuleEvaluation
#include <rule_evaluation.hpp>

Defines an interface for all classes that allow to calculate the predictions of rules, as well as their overall quality, based on confusion matrices.

Template Parameters:

StatisticVector – The type of the vector that provides access to the confusion matrices

Public Functions

inline virtual ~IRuleEvaluation()
virtual const IScoreVector &calculateScores(View<uint32>::const_iterator majorityLabelIndicesBegin, View<uint32>::const_iterator majorityLabelIndicesEnd, const StatisticVector &confusionMatricesTotal, const StatisticVector &confusionMatricesCovered) = 0

Calculates the scores to be predicted by a rule, as well as their overall quality, based on confusion matrices.

Parameters:

  • majorityLabelIndicesBegin – An iterator to the beginning of the indices of the labels that are relevant to the majority of the training examples

  • majorityLabelIndicesEnd – An iterator to the end of the indices of the labels that are relevant to the majority of the training examples

  • confusionMatricesTotal – A reference to an object of template type StatisticVector that stores confusion matrices that take into account all examples

  • confusionMatricesCovered – A reference to an object of template type StatisticVector that stores confusion matrices that take into account all examples, which are covered by the rule

Returns:

A reference to an object of type IScoreVector that stores the predicted scores, as well as their overall quality