File rule_evaluation_label_wise_complete_binned.hpp

namespace boosting
class LabelWiseCompleteBinnedRuleEvaluationFactory : public boosting::ILabelWiseRuleEvaluationFactory
#include <rule_evaluation_label_wise_complete_binned.hpp>

Allows to create instances of the class ILabelWiseRuleEvaluationFactory that allow to calculate the predictions of complete rules, which predict for all available labels, using gradient-based label binning.

Public Functions

LabelWiseCompleteBinnedRuleEvaluationFactory(float64 l1RegularizationWeight, float64 l2RegularizationWeight, std::unique_ptr<ILabelBinningFactory> labelBinningFactoryPtr)
Parameters:

  • l1RegularizationWeight – The weight of the L1 regularization that is applied for calculating the scores to be predicted by rules

  • l2RegularizationWeight – The weight of the L2 regularization that is applied for calculating the scores to be predicted by rules

  • labelBinningFactoryPtr – An unique pointer to an object of type ILabelBinningFactory that allows to create the implementation to be used to assign labels to bins

virtual std::unique_ptr<IRuleEvaluation<DenseLabelWiseStatisticVector>> create(const DenseLabelWiseStatisticVector &statisticVector, const CompleteIndexVector &indexVector) const override

Creates a new instance of the class IRuleEvaluation that allows to calculate the predictions of rules that predict for all available labels, based on the gradients and Hessians that are stored by a DenseLabelWiseStatisticVector.

Parameters:

  • statisticVector – A reference to an object of type DenseLabelWiseStatisticVector. This vector is only used to identify the function that is able to deal with this particular type of vector via function overloading

  • indexVector – A reference to an object of the type CompleteIndexVector that provides access to the indices of the labels for which the rules may predict

Returns:

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

virtual std::unique_ptr<IRuleEvaluation<DenseLabelWiseStatisticVector>> create(const DenseLabelWiseStatisticVector &statisticVector, const PartialIndexVector &indexVector) const override

Creates a new instance of the class IRuleEvaluation that allows to calculate the predictions of rules that predict for a subset of the available labels, based on the gradients and Hessians that are stored by a DenseLabelWiseStatisticVector.

Parameters:

  • statisticVector – A reference to an object of type DenseLabelWiseStatisticVector. This vector is only used to identify the function that is able to deal with this particular type of vector via function overloading

  • indexVector – A reference to an object of the type PartialIndexVector that provides access to the indices of the labels for which the rules may predict

Returns:

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

Private Members

const float64 l1RegularizationWeight_
const float64 l2RegularizationWeight_
const std::unique_ptr<ILabelBinningFactory> labelBinningFactoryPtr_