leaf_splits.hpp 4.16 KB
Newer Older
1
2
3
4
/*!
 * Copyright (c) 2016 Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
Guolin Ke's avatar
Guolin Ke committed
5
6
7
8
9
#ifndef LIGHTGBM_TREELEARNER_LEAF_SPLITS_HPP_
#define LIGHTGBM_TREELEARNER_LEAF_SPLITS_HPP_

#include <LightGBM/meta.h>

10
#include <limits>
Guolin Ke's avatar
Guolin Ke committed
11
12
#include <vector>

13
14
#include "data_partition.hpp"

Guolin Ke's avatar
Guolin Ke committed
15
16
17
namespace LightGBM {

/*!
Qiwei Ye's avatar
Qiwei Ye committed
18
* \brief used to find split candidates for a leaf
Guolin Ke's avatar
Guolin Ke committed
19
20
*/
class LeafSplits {
Nikita Titov's avatar
Nikita Titov committed
21
 public:
Guolin Ke's avatar
Guolin Ke committed
22
  explicit LeafSplits(data_size_t num_data)
Guolin Ke's avatar
Guolin Ke committed
23
    :num_data_in_leaf_(num_data), num_data_(num_data),
Guolin Ke's avatar
Guolin Ke committed
24
25
    data_indices_(nullptr) {
  }
Guolin Ke's avatar
Guolin Ke committed
26
27
28
29
  void ResetNumData(data_size_t num_data) {
    num_data_ = num_data;
    num_data_in_leaf_ = num_data;
  }
Guolin Ke's avatar
Guolin Ke committed
30
31
32
33
  ~LeafSplits() {
  }

  /*!
34

Qiwei Ye's avatar
Qiwei Ye committed
35
  * \brief Init split on current leaf on partial data. 
Guolin Ke's avatar
Guolin Ke committed
36
37
38
39
40
  * \param leaf Index of current leaf
  * \param data_partition current data partition
  * \param sum_gradients
  * \param sum_hessians
  */
Guolin Ke's avatar
Guolin Ke committed
41
  void Init(int leaf, const DataPartition* data_partition, double sum_gradients, double sum_hessians) {
Guolin Ke's avatar
Guolin Ke committed
42
    leaf_index_ = leaf;
Guolin Ke's avatar
Guolin Ke committed
43
    data_indices_ = data_partition->GetIndexOnLeaf(leaf, &num_data_in_leaf_);
Guolin Ke's avatar
Guolin Ke committed
44
45
    sum_gradients_ = sum_gradients;
    sum_hessians_ = sum_hessians;
Guolin Ke's avatar
Guolin Ke committed
46
47
  }

Guolin Ke's avatar
Guolin Ke committed
48
  /*!
49
  * \brief Init splits on current leaf, it will traverse all data to sum up the results
Guolin Ke's avatar
Guolin Ke committed
50
51
52
  * \param gradients
  * \param hessians
  */
53
  void Init(const score_t* gradients, const score_t* hessians) {
Guolin Ke's avatar
Guolin Ke committed
54
55
56
    num_data_in_leaf_ = num_data_;
    leaf_index_ = 0;
    data_indices_ = nullptr;
Guolin Ke's avatar
Guolin Ke committed
57
58
    double tmp_sum_gradients = 0.0f;
    double tmp_sum_hessians = 0.0f;
Guolin Ke's avatar
Guolin Ke committed
59
60
61
62
63
64
65
66
67
68
#pragma omp parallel for schedule(static) reduction(+:tmp_sum_gradients, tmp_sum_hessians)
    for (data_size_t i = 0; i < num_data_in_leaf_; ++i) {
      tmp_sum_gradients += gradients[i];
      tmp_sum_hessians += hessians[i];
    }
    sum_gradients_ = tmp_sum_gradients;
    sum_hessians_ = tmp_sum_hessians;
  }

  /*!
Qiwei Ye's avatar
Qiwei Ye committed
69
  * \brief Init splits on current leaf of partial data.
Guolin Ke's avatar
Guolin Ke committed
70
71
72
73
74
  * \param leaf Index of current leaf
  * \param data_partition current data partition
  * \param gradients
  * \param hessians
  */
75
  void Init(int leaf, const DataPartition* data_partition, const score_t* gradients, const score_t* hessians) {
Guolin Ke's avatar
Guolin Ke committed
76
    leaf_index_ = leaf;
Guolin Ke's avatar
Guolin Ke committed
77
    data_indices_ = data_partition->GetIndexOnLeaf(leaf, &num_data_in_leaf_);
Guolin Ke's avatar
Guolin Ke committed
78
79
    double tmp_sum_gradients = 0.0f;
    double tmp_sum_hessians = 0.0f;
Guolin Ke's avatar
Guolin Ke committed
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
#pragma omp parallel for schedule(static) reduction(+:tmp_sum_gradients, tmp_sum_hessians)
    for (data_size_t i = 0; i < num_data_in_leaf_; ++i) {
      data_size_t idx = data_indices_[i];
      tmp_sum_gradients += gradients[idx];
      tmp_sum_hessians += hessians[idx];
    }
    sum_gradients_ = tmp_sum_gradients;
    sum_hessians_ = tmp_sum_hessians;
  }


  /*!
  * \brief Init splits on current leaf, only update sum_gradients and sum_hessians
  * \param sum_gradients
  * \param sum_hessians
  */
Guolin Ke's avatar
Guolin Ke committed
96
  void Init(double sum_gradients, double sum_hessians) {
Guolin Ke's avatar
Guolin Ke committed
97
98
99
100
101
102
103
104
105
106
    leaf_index_ = 0;
    sum_gradients_ = sum_gradients;
    sum_hessians_ = sum_hessians;
  }

  /*!
  * \brief Init splits on current leaf
  */
  void Init() {
    leaf_index_ = -1;
Guolin Ke's avatar
Guolin Ke committed
107
108
    data_indices_ = nullptr;
    num_data_in_leaf_ = 0;
Guolin Ke's avatar
Guolin Ke committed
109
110
111
112
  }


  /*! \brief Get current leaf index */
113
  int leaf_index() const { return leaf_index_; }
Guolin Ke's avatar
Guolin Ke committed
114
115
116
117
118

  /*! \brief Get numer of data in current leaf */
  data_size_t num_data_in_leaf() const { return num_data_in_leaf_; }

  /*! \brief Get sum of gradients of current leaf */
Guolin Ke's avatar
Guolin Ke committed
119
  double sum_gradients() const { return sum_gradients_; }
120

Guolin Ke's avatar
Guolin Ke committed
121
  /*! \brief Get sum of hessians of current leaf */
Guolin Ke's avatar
Guolin Ke committed
122
  double sum_hessians() const { return sum_hessians_; }
Guolin Ke's avatar
Guolin Ke committed
123
124

  /*! \brief Get indices of data of current leaf */
Guolin Ke's avatar
Guolin Ke committed
125
  const data_size_t* data_indices() const { return data_indices_; }
Guolin Ke's avatar
Guolin Ke committed
126
127


Nikita Titov's avatar
Nikita Titov committed
128
 private:
Guolin Ke's avatar
Guolin Ke committed
129
130
131
132
133
134
135
  /*! \brief current leaf index */
  int leaf_index_;
  /*! \brief number of data on current leaf */
  data_size_t num_data_in_leaf_;
  /*! \brief number of all training data */
  data_size_t num_data_;
  /*! \brief sum of gradients of current leaf */
Guolin Ke's avatar
Guolin Ke committed
136
  double sum_gradients_;
Guolin Ke's avatar
Guolin Ke committed
137
  /*! \brief sum of hessians of current leaf */
Guolin Ke's avatar
Guolin Ke committed
138
  double sum_hessians_;
Guolin Ke's avatar
Guolin Ke committed
139
  /*! \brief indices of data of current leaf */
Guolin Ke's avatar
Guolin Ke committed
140
  const data_size_t* data_indices_;
Guolin Ke's avatar
Guolin Ke committed
141
142
143
};

}  // namespace LightGBM
Guolin Ke's avatar
Guolin Ke committed
144
#endif   // LightGBM_TREELEARNER_LEAF_SPLITS_HPP_