AllCategoricalSplit< FitnessFunction > Class Template Reference

The AllCategoricalSplit is a splitting function that will split categorical features into many children: one child for each category. More...

Classes

class  AuxiliarySplitInfo
 

Static Public Member Functions

template
<
typename
ElemType
>
static size_t CalculateDirection (const ElemType &point, const arma::Col< ElemType > &classProbabilities, const AuxiliarySplitInfo< ElemType > &)
 Calculate the direction a point should percolate to. More...

 
template
<
typename
ElemType
>
static size_t NumChildren (const arma::Col< ElemType > &classProbabilities, const AuxiliarySplitInfo< ElemType > &)
 Return the number of children in the split. More...

 
template<bool UseWeights, typename VecType , typename WeightVecType >
static double SplitIfBetter (const double bestGain, const VecType &data, const size_t numCategories, const arma::Row< size_t > &labels, const size_t numClasses, const WeightVecType &weights, const size_t minimumLeafSize, const double minimumGainSplit, arma::Col< typename VecType::elem_type > &classProbabilities, AuxiliarySplitInfo< typename VecType::elem_type > &aux)
 Check if we can split a node. More...

 

Detailed Description


template
<
typename
FitnessFunction
>

class mlpack::tree::AllCategoricalSplit< FitnessFunction >

The AllCategoricalSplit is a splitting function that will split categorical features into many children: one child for each category.

Template Parameters
FitnessFunctionFitness function to evaluate gain with.

Definition at line 28 of file all_categorical_split.hpp.

Member Function Documentation

◆ CalculateDirection()

static size_t CalculateDirection ( const ElemType &  point,
const arma::Col< ElemType > &  classProbabilities,
const AuxiliarySplitInfo< ElemType > &   
)
static

Calculate the direction a point should percolate to.

Parameters
classProbabilitiesAuxiliary information for the split.
aux(Unused) auxiliary information for the split.

◆ NumChildren()

static size_t NumChildren ( const arma::Col< ElemType > &  classProbabilities,
const AuxiliarySplitInfo< ElemType > &   
)
static

Return the number of children in the split.

Parameters
classProbabilitiesAuxiliary information for the split.
aux(Unused) auxiliary information for the split.

◆ SplitIfBetter()

static double SplitIfBetter ( const double  bestGain,
const VecType &  data,
const size_t  numCategories,
const arma::Row< size_t > &  labels,
const size_t  numClasses,
const WeightVecType &  weights,
const size_t  minimumLeafSize,
const double  minimumGainSplit,
arma::Col< typename VecType::elem_type > &  classProbabilities,
AuxiliarySplitInfo< typename VecType::elem_type > &  aux 
)
static

Check if we can split a node.

If we can split a node in a way that improves on 'bestGain', then we return the improved gain. Otherwise we return the value 'bestGain'. If a split is made, then classProbabilities and aux may be modified. For this particular split type, aux will be empty and classProbabilities will hold one element—the number of children.

Parameters
bestGainBest gain seen so far (we'll only split if we find gain better than this).
dataThe dimension of data points to check for a split in.
numCategoriesNumber of categories in the categorical data.
labelsLabels for each point.
numClassesNumber of classes in the dataset.
minimumLeafSizeMinimum number of points in a leaf node for splitting.
classProbabilitiesClass probabilities vector, which may be filled with split information a successful split.
auxAuxiliary split information, which may be modified on a successful split.

The documentation for this class was generated from the following file: