Medial Code Documentation
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions
LightGBM::FeatureHistogram Class Reference

FeatureHistogram is used to construct and store a histogram for a feature. More...

#include <feature_histogram.hpp>

Public Member Functions

FeatureHistogramoperator= (const FeatureHistogram &)=delete
 Disable copy.
 
 FeatureHistogram (const FeatureHistogram &)=delete
 Disable copy.
 
void Init (HistogramBinEntry *data, const FeatureMetainfo *meta)
 Init the feature histogram.
 
HistogramBinEntryRawData ()
 
void Subtract (const FeatureHistogram &other)
 Subtract current histograms with other.
 
void FindBestThreshold (double sum_gradient, double sum_hessian, data_size_t num_data, double min_constraint, double max_constraint, SplitInfo *output)
 
void FindBestThresholdNumerical (double sum_gradient, double sum_hessian, data_size_t num_data, double min_constraint, double max_constraint, SplitInfo *output)
 
void FindBestThresholdCategorical (double sum_gradient, double sum_hessian, data_size_t num_data, double min_constraint, double max_constraint, SplitInfo *output)
 
void GatherInfoForThreshold (double sum_gradient, double sum_hessian, uint32_t threshold, data_size_t num_data, SplitInfo *output)
 
void GatherInfoForThresholdNumerical (double sum_gradient, double sum_hessian, uint32_t threshold, data_size_t num_data, SplitInfo *output)
 
void GatherInfoForThresholdCategorical (double sum_gradient, double sum_hessian, uint32_t threshold, data_size_t num_data, SplitInfo *output)
 
int SizeOfHistgram () const
 Binary size of this histogram.
 
void FromMemory (char *memory_data)
 Restore histogram from memory.
 
bool is_splittable ()
 True if this histogram can be splitted.
 
void set_is_splittable (bool val)
 Set splittable to this histogram.
 

Static Public Member Functions

static double ThresholdL1 (double s, double l1)
 
static double CalculateSplittedLeafOutput (double sum_gradients, double sum_hessians, double l1, double l2, double max_delta_step)
 

Detailed Description

FeatureHistogram is used to construct and store a histogram for a feature.

Member Function Documentation

◆ Init()

void LightGBM::FeatureHistogram::Init ( HistogramBinEntry data,
const FeatureMetainfo meta 
)
inline

Init the feature histogram.

Parameters
featurethe feature data for this histogram
min_num_data_one_leafminimal number of data in one leaf

◆ Subtract()

void LightGBM::FeatureHistogram::Subtract ( const FeatureHistogram other)
inline

Subtract current histograms with other.

Parameters
otherThe histogram that want to subtract

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