xgboost
base.h
Go to the documentation of this file.
1 
6 #ifndef XGBOOST_BASE_H_
7 #define XGBOOST_BASE_H_
8 
9 #include <dmlc/base.h>
10 #include <dmlc/omp.h>
11 #include <cmath>
12 #include <iostream>
13 #include <vector>
14 #include <string>
15 #include <utility>
16 
20 #ifndef XGBOOST_STRICT_R_MODE
21 #define XGBOOST_STRICT_R_MODE 0
22 #endif // XGBOOST_STRICT_R_MODE
23 
30 #ifndef XGBOOST_LOG_WITH_TIME
31 #define XGBOOST_LOG_WITH_TIME 1
32 #endif // XGBOOST_LOG_WITH_TIME
33 
37 #ifndef XGBOOST_CUSTOMIZE_LOGGER
38 #define XGBOOST_CUSTOMIZE_LOGGER XGBOOST_STRICT_R_MODE
39 #endif // XGBOOST_CUSTOMIZE_LOGGER
40 
44 #ifndef XGBOOST_CUSTOMIZE_GLOBAL_PRNG
45 #define XGBOOST_CUSTOMIZE_GLOBAL_PRNG XGBOOST_STRICT_R_MODE
46 #endif // XGBOOST_CUSTOMIZE_GLOBAL_PRNG
47 
51 #if defined(__GNUC__) && ((__GNUC__ == 4 && __GNUC_MINOR__ >= 8) || __GNUC__ > 4)
52 #define XGBOOST_ALIGNAS(X) alignas(X)
53 #else
54 #define XGBOOST_ALIGNAS(X)
55 #endif // defined(__GNUC__) && ((__GNUC__ == 4 && __GNUC_MINOR__ >= 8) || __GNUC__ > 4)
56 
57 #if defined(__GNUC__) && ((__GNUC__ == 4 && __GNUC_MINOR__ >= 8) || __GNUC__ > 4) && \
58  !defined(__CUDACC__) && !defined(__sun) && !defined(sun)
59 #include <parallel/algorithm>
60 #define XGBOOST_PARALLEL_SORT(X, Y, Z) __gnu_parallel::sort((X), (Y), (Z))
61 #define XGBOOST_PARALLEL_STABLE_SORT(X, Y, Z) \
62  __gnu_parallel::stable_sort((X), (Y), (Z))
63 #elif defined(_MSC_VER) && (!__INTEL_COMPILER)
64 #include <ppl.h>
65 #define XGBOOST_PARALLEL_SORT(X, Y, Z) concurrency::parallel_sort((X), (Y), (Z))
66 #define XGBOOST_PARALLEL_STABLE_SORT(X, Y, Z) std::stable_sort((X), (Y), (Z))
67 #else
68 #define XGBOOST_PARALLEL_SORT(X, Y, Z) std::sort((X), (Y), (Z))
69 #define XGBOOST_PARALLEL_STABLE_SORT(X, Y, Z) std::stable_sort((X), (Y), (Z))
70 #endif // GLIBC VERSION
71 
72 #if defined(__GNUC__)
73 #define XGBOOST_EXPECT(cond, ret) __builtin_expect((cond), (ret))
74 #else
75 #define XGBOOST_EXPECT(cond, ret) (cond)
76 #endif // defined(__GNUC__)
77 
81 #if defined (__CUDA__) || defined(__NVCC__)
82 #define XGBOOST_DEVICE __host__ __device__
83 #else
84 #define XGBOOST_DEVICE
85 #endif // defined (__CUDA__) || defined(__NVCC__)
86 
87 #if defined(__CUDA__) || defined(__CUDACC__)
88 #define XGBOOST_HOST_DEV_INLINE XGBOOST_DEVICE __forceinline__
89 #define XGBOOST_DEV_INLINE __device__ __forceinline__
90 #else
91 #define XGBOOST_HOST_DEV_INLINE
92 #define XGBOOST_DEV_INLINE
93 #endif // defined(__CUDA__) || defined(__CUDACC__)
94 
95 // These check are for Makefile.
96 #if !defined(XGBOOST_MM_PREFETCH_PRESENT) && !defined(XGBOOST_BUILTIN_PREFETCH_PRESENT)
97 /* default logic for software pre-fetching */
98 #if (defined(_MSC_VER) && (defined(_M_IX86) || defined(_M_AMD64))) || defined(__INTEL_COMPILER)
99 // Enable _mm_prefetch for Intel compiler and MSVC+x86
100  #define XGBOOST_MM_PREFETCH_PRESENT
101  #define XGBOOST_BUILTIN_PREFETCH_PRESENT
102 #elif defined(__GNUC__)
103 // Enable __builtin_prefetch for GCC
104 #define XGBOOST_BUILTIN_PREFETCH_PRESENT
105 #endif // GUARDS
106 
107 #endif // !defined(XGBOOST_MM_PREFETCH_PRESENT) && !defined()
108 
110 namespace xgboost {
111 
113 using bst_uint = uint32_t; // NOLINT
115 using bst_int = int32_t; // NOLINT
117 using bst_ulong = uint64_t; // NOLINT
119 using bst_float = float; // NOLINT
121 using bst_cat_t = int32_t; // NOLINT
123 using bst_feature_t = uint32_t; // NOLINT
130 using bst_row_t = std::size_t; // NOLINT
132 using bst_node_t = int32_t; // NOLINT
134 using bst_group_t = uint32_t; // NOLINT
135 
136 namespace detail {
140 template <typename T>
143  T grad_;
145  T hess_;
146 
147  XGBOOST_DEVICE void SetGrad(T g) { grad_ = g; }
148  XGBOOST_DEVICE void SetHess(T h) { hess_ = h; }
149 
150  public:
151  using ValueT = T;
152 
153  inline void Add(const ValueT& grad, const ValueT& hess) {
154  grad_ += grad;
155  hess_ += hess;
156  }
157 
158  inline static void Reduce(GradientPairInternal<T>& a, const GradientPairInternal<T>& b) { // NOLINT(*)
159  a += b;
160  }
161 
162  XGBOOST_DEVICE GradientPairInternal() : grad_(0), hess_(0) {}
163 
165  SetGrad(grad);
166  SetHess(hess);
167  }
168 
169  // Copy constructor if of same value type, marked as default to be trivially_copyable
170  GradientPairInternal(const GradientPairInternal<T> &g) = default;
171 
172  // Copy constructor if different value type - use getters and setters to
173  // perform conversion
174  template <typename T2>
176  SetGrad(g.GetGrad());
177  SetHess(g.GetHess());
178  }
179 
180  XGBOOST_DEVICE T GetGrad() const { return grad_; }
181  XGBOOST_DEVICE T GetHess() const { return hess_; }
182 
184  const GradientPairInternal<T> &rhs) {
185  grad_ += rhs.grad_;
186  hess_ += rhs.hess_;
187  return *this;
188  }
189 
191  const GradientPairInternal<T> &rhs) const {
193  g.grad_ = grad_ + rhs.grad_;
194  g.hess_ = hess_ + rhs.hess_;
195  return g;
196  }
197 
199  const GradientPairInternal<T> &rhs) {
200  grad_ -= rhs.grad_;
201  hess_ -= rhs.hess_;
202  return *this;
203  }
204 
206  const GradientPairInternal<T> &rhs) const {
208  g.grad_ = grad_ - rhs.grad_;
209  g.hess_ = hess_ - rhs.hess_;
210  return g;
211  }
212 
214  grad_ *= multiplier;
215  hess_ *= multiplier;
216  return *this;
217  }
218 
221  g.grad_ = grad_ * multiplier;
222  g.hess_ = hess_ * multiplier;
223  return g;
224  }
225 
227  grad_ /= divisor;
228  hess_ /= divisor;
229  return *this;
230  }
231 
234  g.grad_ = grad_ / divisor;
235  g.hess_ = hess_ / divisor;
236  return g;
237  }
238 
240  return grad_ == rhs.grad_ && hess_ == rhs.hess_;
241  }
242 
243  XGBOOST_DEVICE explicit GradientPairInternal(int value) {
244  *this = GradientPairInternal<T>(static_cast<float>(value),
245  static_cast<float>(value));
246  }
247 
248  friend std::ostream &operator<<(std::ostream &os,
249  const GradientPairInternal<T> &g) {
250  os << g.GetGrad() << "/" << g.GetHess();
251  return os;
252  }
253 };
254 } // namespace detail
255 
264 
265 using Args = std::vector<std::pair<std::string, std::string> >;
266 
268 constexpr bst_float kRtEps = 1e-6f;
269 
271 using omp_ulong = dmlc::omp_ulong; // NOLINT
273 using bst_omp_uint = dmlc::omp_uint; // NOLINT
275 using XGBoostVersionT = int32_t;
276 
281 #if DMLC_USE_CXX11 && defined(__GNUC__) && !defined(__clang_version__)
282 #if __GNUC__ == 4 && __GNUC_MINOR__ < 8
283 #define override
284 #define final
285 #endif // __GNUC__ == 4 && __GNUC_MINOR__ < 8
286 #endif // DMLC_USE_CXX11 && defined(__GNUC__) && !defined(__clang_version__)
287 } // namespace xgboost
288 
289 #endif // XGBOOST_BASE_H_
xgboost::detail::GradientPairInternal::GradientPairInternal
XGBOOST_DEVICE GradientPairInternal(int value)
Definition: base.h:243
xgboost::detail::GradientPairInternal::operator/=
XGBOOST_DEVICE GradientPairInternal< T > & operator/=(float divisor)
Definition: base.h:226
xgboost::Args
std::vector< std::pair< std::string, std::string > > Args
Definition: base.h:265
xgboost::bst_int
int32_t bst_int
integer type.
Definition: base.h:115
xgboost::detail::GradientPairInternal
Implementation of gradient statistics pair. Template specialisation may be used to overload different...
Definition: base.h:141
xgboost::detail::GradientPairInternal::operator*
XGBOOST_DEVICE GradientPairInternal< T > operator*(float multiplier) const
Definition: base.h:219
xgboost::detail::GradientPairInternal::operator-=
XGBOOST_DEVICE GradientPairInternal< T > & operator-=(const GradientPairInternal< T > &rhs)
Definition: base.h:198
xgboost::detail::GradientPairInternal::GradientPairInternal
XGBOOST_DEVICE GradientPairInternal(const GradientPairInternal< T2 > &g)
Definition: base.h:175
xgboost::detail::GradientPairInternal::operator==
XGBOOST_DEVICE bool operator==(const GradientPairInternal< T > &rhs) const
Definition: base.h:239
xgboost::XGBoostVersionT
int32_t XGBoostVersionT
Type used for representing version number in binary form.
Definition: base.h:275
xgboost::detail::GradientPairInternal::GradientPairInternal
XGBOOST_DEVICE GradientPairInternal()
Definition: base.h:162
xgboost::omp_ulong
dmlc::omp_ulong omp_ulong
define unsigned long for openmp loop
Definition: base.h:271
xgboost::bst_ulong
uint64_t bst_ulong
unsigned long integers
Definition: base.h:117
xgboost::detail::GradientPairInternal::operator/
XGBOOST_DEVICE GradientPairInternal< T > operator/(float divisor) const
Definition: base.h:232
xgboost::bst_feature_t
uint32_t bst_feature_t
Type for data column (feature) index.
Definition: base.h:123
xgboost::bst_omp_uint
dmlc::omp_uint bst_omp_uint
define unsigned int for openmp loop
Definition: base.h:273
xgboost::bst_group_t
uint32_t bst_group_t
Type for ranking group index.
Definition: base.h:134
xgboost::detail::GradientPairInternal::Add
void Add(const ValueT &grad, const ValueT &hess)
Definition: base.h:153
xgboost::detail::GradientPairInternal::operator+=
XGBOOST_DEVICE GradientPairInternal< T > & operator+=(const GradientPairInternal< T > &rhs)
Definition: base.h:183
xgboost::detail::GradientPairInternal::GetGrad
XGBOOST_DEVICE T GetGrad() const
Definition: base.h:180
xgboost::bst_cat_t
int32_t bst_cat_t
Categorical value type.
Definition: base.h:121
xgboost::bst_node_t
int32_t bst_node_t
Type for tree node index.
Definition: base.h:132
xgboost::bst_row_t
std::size_t bst_row_t
Type for data row index.
Definition: base.h:130
xgboost::detail::GradientPairInternal::operator-
XGBOOST_DEVICE GradientPairInternal< T > operator-(const GradientPairInternal< T > &rhs) const
Definition: base.h:205
xgboost::detail::GradientPairInternal::operator+
XGBOOST_DEVICE GradientPairInternal< T > operator+(const GradientPairInternal< T > &rhs) const
Definition: base.h:190
xgboost::detail::GradientPairInternal::operator<<
friend std::ostream & operator<<(std::ostream &os, const GradientPairInternal< T > &g)
Definition: base.h:248
xgboost::kRtEps
constexpr bst_float kRtEps
small eps gap for minimum split decision.
Definition: base.h:268
xgboost::detail::GradientPairInternal::GradientPairInternal
XGBOOST_DEVICE GradientPairInternal(T grad, T hess)
Definition: base.h:164
xgboost::detail::GradientPairInternal::ValueT
T ValueT
Definition: base.h:151
xgboost::bst_uint
uint32_t bst_uint
unsigned integer type used for feature index.
Definition: base.h:113
XGBOOST_DEVICE
#define XGBOOST_DEVICE
Tag function as usable by device.
Definition: base.h:84
xgboost::detail::GradientPairInternal::GetHess
XGBOOST_DEVICE T GetHess() const
Definition: base.h:181
xgboost::detail::GradientPairInternal::Reduce
static void Reduce(GradientPairInternal< T > &a, const GradientPairInternal< T > &b)
Definition: base.h:158
xgboost::detail::GradientPairInternal::operator*=
XGBOOST_DEVICE GradientPairInternal< T > & operator*=(float multiplier)
Definition: base.h:213
xgboost
namespace of xgboost
Definition: base.h:110
xgboost::bst_float
float bst_float
float type, used for storing statistics
Definition: base.h:119