c_api.cpp 115 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
#include <LightGBM/c_api.h>
Guolin Ke's avatar
Guolin Ke committed
6

7
#include <LightGBM/arrow.h>
Guolin Ke's avatar
Guolin Ke committed
8
9
#include <LightGBM/boosting.h>
#include <LightGBM/config.h>
10
11
12
#include <LightGBM/dataset.h>
#include <LightGBM/dataset_loader.h>
#include <LightGBM/metric.h>
13
#include <LightGBM/network.h>
14
15
#include <LightGBM/objective_function.h>
#include <LightGBM/prediction_early_stop.h>
16
#include <LightGBM/utils/byte_buffer.h>
17
18
19
20
21
#include <LightGBM/utils/common.h>
#include <LightGBM/utils/log.h>
#include <LightGBM/utils/openmp_wrapper.h>
#include <LightGBM/utils/random.h>
#include <LightGBM/utils/threading.h>
Guolin Ke's avatar
Guolin Ke committed
22

23
24
25
26
27
28
29
30
#include <string>
#include <cstdio>
#include <functional>
#include <memory>
#include <mutex>
#include <stdexcept>
#include <vector>

31
#include "application/predictor.hpp"
32
33
#include <LightGBM/utils/yamc/alternate_shared_mutex.hpp>
#include <LightGBM/utils/yamc/yamc_shared_lock.hpp>
Guolin Ke's avatar
Guolin Ke committed
34

Guolin Ke's avatar
Guolin Ke committed
35
36
namespace LightGBM {

Guolin Ke's avatar
Guolin Ke committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
inline int LGBM_APIHandleException(const std::exception& ex) {
  LGBM_SetLastError(ex.what());
  return -1;
}
inline int LGBM_APIHandleException(const std::string& ex) {
  LGBM_SetLastError(ex.c_str());
  return -1;
}

#define API_BEGIN() try {
#define API_END() } \
catch(std::exception& ex) { return LGBM_APIHandleException(ex); } \
catch(std::string& ex) { return LGBM_APIHandleException(ex); } \
catch(...) { return LGBM_APIHandleException("unknown exception"); } \
return 0;

53
54
55
56
57
58
#define UNIQUE_LOCK(mtx) \
std::unique_lock<yamc::alternate::shared_mutex> lock(mtx);

#define SHARED_LOCK(mtx) \
yamc::shared_lock<yamc::alternate::shared_mutex> lock(&mtx);

59
60
61
const int PREDICTOR_TYPES = 4;

// Single row predictor to abstract away caching logic
62
class SingleRowPredictorInner {
63
64
65
66
 public:
  PredictFunction predict_function;
  int64_t num_pred_in_one_row;

67
  SingleRowPredictorInner(int predict_type, Boosting* boosting, const Config& config, int start_iter, int num_iter) {
68
69
70
71
72
73
74
75
76
77
78
79
80
    bool is_predict_leaf = false;
    bool is_raw_score = false;
    bool predict_contrib = false;
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
      is_predict_leaf = true;
    } else if (predict_type == C_API_PREDICT_RAW_SCORE) {
      is_raw_score = true;
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
      predict_contrib = true;
    }
    early_stop_ = config.pred_early_stop;
    early_stop_freq_ = config.pred_early_stop_freq;
    early_stop_margin_ = config.pred_early_stop_margin;
81
82
    iter_ = num_iter;
    predictor_.reset(new Predictor(boosting, start_iter, iter_, is_raw_score, is_predict_leaf, predict_contrib,
83
                                   early_stop_, early_stop_freq_, early_stop_margin_));
84
    num_pred_in_one_row = boosting->NumPredictOneRow(start_iter, iter_, is_predict_leaf, predict_contrib);
85
    predict_function = predictor_->GetPredictFunction();
Guolin Ke's avatar
Guolin Ke committed
86
    num_total_model_ = boosting->NumberOfTotalModel();
87
  }
88

89
  ~SingleRowPredictorInner() {}
90

Guolin Ke's avatar
Guolin Ke committed
91
  bool IsPredictorEqual(const Config& config, int iter, Boosting* boosting) {
92
93
94
95
96
    return early_stop_ == config.pred_early_stop &&
      early_stop_freq_ == config.pred_early_stop_freq &&
      early_stop_margin_ == config.pred_early_stop_margin &&
      iter_ == iter &&
      num_total_model_ == boosting->NumberOfTotalModel();
97
  }
Guolin Ke's avatar
Guolin Ke committed
98

99
100
101
102
103
104
105
106
107
 private:
  std::unique_ptr<Predictor> predictor_;
  bool early_stop_;
  int early_stop_freq_;
  double early_stop_margin_;
  int iter_;
  int num_total_model_;
};

108
109
/*!
 * \brief Object to store resources meant for single-row Fast Predict methods.
110
 *
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 * For legacy reasons this is called `FastConfig` in the public C API.
 *
 * Meant to be used by the *Fast* predict methods only.
 * It stores the configuration and prediction resources for reuse across predictions.
 */
struct SingleRowPredictor {
 public:
  SingleRowPredictor(yamc::alternate::shared_mutex *booster_mutex,
             const char *parameters,
             const int data_type,
             const int32_t num_cols,
             int predict_type,
             Boosting *boosting,
             int start_iter,
             int num_iter) : config(Config::Str2Map(parameters)), data_type(data_type), num_cols(num_cols), single_row_predictor_inner(predict_type, boosting, config, start_iter, num_iter), booster_mutex(booster_mutex) {
    if (!config.predict_disable_shape_check && num_cols != boosting->MaxFeatureIdx() + 1) {
      Log::Fatal("The number of features in data (%d) is not the same as it was in training data (%d).\n"\
                 "You can set ``predict_disable_shape_check=true`` to discard this error, but please be aware what you are doing.", num_cols, boosting->MaxFeatureIdx() + 1);
    }
  }

  void Predict(std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun,
               double* out_result, int64_t* out_len) const {
    UNIQUE_LOCK(single_row_predictor_mutex)
    yamc::shared_lock<yamc::alternate::shared_mutex> booster_shared_lock(booster_mutex);

    auto one_row = get_row_fun(0);
    single_row_predictor_inner.predict_function(one_row, out_result);

    *out_len = single_row_predictor_inner.num_pred_in_one_row;
  }

 public:
  Config config;
  const int data_type;
  const int32_t num_cols;

 private:
  SingleRowPredictorInner single_row_predictor_inner;

  // Prevent the booster from being modified while we have a predictor relying on it during prediction
  yamc::alternate::shared_mutex *booster_mutex;

  // If several threads try to predict at the same time using the same SingleRowPredictor
  // we want them to still provide correct values, so the mutex is necessary due to the shared
  // resources in the predictor.
  // However the recommended approach is to instantiate one SingleRowPredictor per thread,
  // to avoid contention here.
  mutable yamc::alternate::shared_mutex single_row_predictor_mutex;
};

Guolin Ke's avatar
Guolin Ke committed
162
class Booster {
Nikita Titov's avatar
Nikita Titov committed
163
 public:
Guolin Ke's avatar
Guolin Ke committed
164
  explicit Booster(const char* filename) {
165
    boosting_.reset(Boosting::CreateBoosting("gbdt", filename));
166
167
  }

Guolin Ke's avatar
Guolin Ke committed
168
  Booster(const Dataset* train_data,
169
          const char* parameters) {
Guolin Ke's avatar
Guolin Ke committed
170
    auto param = Config::Str2Map(parameters);
wxchan's avatar
wxchan committed
171
    config_.Set(param);
172
    OMP_SET_NUM_THREADS(config_.num_threads);
Guolin Ke's avatar
Guolin Ke committed
173
    // create boosting
Guolin Ke's avatar
Guolin Ke committed
174
    if (config_.input_model.size() > 0) {
175
176
      Log::Warning("Continued train from model is not supported for c_api,\n"
                   "please use continued train with input score");
Guolin Ke's avatar
Guolin Ke committed
177
    }
Guolin Ke's avatar
Guolin Ke committed
178

Guolin Ke's avatar
Guolin Ke committed
179
    boosting_.reset(Boosting::CreateBoosting(config_.boosting, nullptr));
Guolin Ke's avatar
Guolin Ke committed
180

181
182
    train_data_ = train_data;
    CreateObjectiveAndMetrics();
Guolin Ke's avatar
Guolin Ke committed
183
    // initialize the boosting
Guolin Ke's avatar
Guolin Ke committed
184
    if (config_.tree_learner == std::string("feature")) {
185
      Log::Fatal("Do not support feature parallel in c api");
186
    }
Guolin Ke's avatar
Guolin Ke committed
187
    if (Network::num_machines() == 1 && config_.tree_learner != std::string("serial")) {
188
      Log::Warning("Only find one worker, will switch to serial tree learner");
Guolin Ke's avatar
Guolin Ke committed
189
      config_.tree_learner = "serial";
190
    }
Guolin Ke's avatar
Guolin Ke committed
191
    boosting_->Init(&config_, train_data_, objective_fun_.get(),
192
                    Common::ConstPtrInVectorWrapper<Metric>(train_metric_));
wxchan's avatar
wxchan committed
193
194
195
  }

  void MergeFrom(const Booster* other) {
196
    UNIQUE_LOCK(mutex_)
wxchan's avatar
wxchan committed
197
    boosting_->MergeFrom(other->boosting_.get());
Guolin Ke's avatar
Guolin Ke committed
198
199
200
201
  }

  ~Booster() {
  }
202

203
  void CreateObjectiveAndMetrics() {
Guolin Ke's avatar
Guolin Ke committed
204
    // create objective function
Guolin Ke's avatar
Guolin Ke committed
205
206
    objective_fun_.reset(ObjectiveFunction::CreateObjectiveFunction(config_.objective,
                                                                    config_));
Guolin Ke's avatar
Guolin Ke committed
207
    if (objective_fun_ == nullptr) {
208
      Log::Info("Using self-defined objective function");
Guolin Ke's avatar
Guolin Ke committed
209
210
211
212
213
214
215
216
    }
    // initialize the objective function
    if (objective_fun_ != nullptr) {
      objective_fun_->Init(train_data_->metadata(), train_data_->num_data());
    }

    // create training metric
    train_metric_.clear();
Guolin Ke's avatar
Guolin Ke committed
217
    for (auto metric_type : config_.metric) {
Guolin Ke's avatar
Guolin Ke committed
218
      auto metric = std::unique_ptr<Metric>(
Guolin Ke's avatar
Guolin Ke committed
219
        Metric::CreateMetric(metric_type, config_));
Guolin Ke's avatar
Guolin Ke committed
220
221
222
223
224
      if (metric == nullptr) { continue; }
      metric->Init(train_data_->metadata(), train_data_->num_data());
      train_metric_.push_back(std::move(metric));
    }
    train_metric_.shrink_to_fit();
225
226
227
228
  }

  void ResetTrainingData(const Dataset* train_data) {
    if (train_data != train_data_) {
229
      UNIQUE_LOCK(mutex_)
230
231
232
233
234
235
      train_data_ = train_data;
      CreateObjectiveAndMetrics();
      // reset the boosting
      boosting_->ResetTrainingData(train_data_,
                                   objective_fun_.get(), Common::ConstPtrInVectorWrapper<Metric>(train_metric_));
    }
wxchan's avatar
wxchan committed
236
237
  }

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
  static void CheckDatasetResetConfig(
      const Config& old_config,
      const std::unordered_map<std::string, std::string>& new_param) {
    Config new_config;
    new_config.Set(new_param);
    if (new_param.count("data_random_seed") &&
        new_config.data_random_seed != old_config.data_random_seed) {
      Log::Fatal("Cannot change data_random_seed after constructed Dataset handle.");
    }
    if (new_param.count("max_bin") &&
        new_config.max_bin != old_config.max_bin) {
      Log::Fatal("Cannot change max_bin after constructed Dataset handle.");
    }
    if (new_param.count("max_bin_by_feature") &&
        new_config.max_bin_by_feature != old_config.max_bin_by_feature) {
      Log::Fatal(
          "Cannot change max_bin_by_feature after constructed Dataset handle.");
    }
    if (new_param.count("bin_construct_sample_cnt") &&
        new_config.bin_construct_sample_cnt !=
            old_config.bin_construct_sample_cnt) {
      Log::Fatal(
          "Cannot change bin_construct_sample_cnt after constructed Dataset "
          "handle.");
    }
    if (new_param.count("min_data_in_bin") &&
        new_config.min_data_in_bin != old_config.min_data_in_bin) {
      Log::Fatal(
          "Cannot change min_data_in_bin after constructed Dataset handle.");
    }
    if (new_param.count("use_missing") &&
        new_config.use_missing != old_config.use_missing) {
      Log::Fatal("Cannot change use_missing after constructed Dataset handle.");
    }
    if (new_param.count("zero_as_missing") &&
        new_config.zero_as_missing != old_config.zero_as_missing) {
      Log::Fatal(
          "Cannot change zero_as_missing after constructed Dataset handle.");
    }
    if (new_param.count("categorical_feature") &&
        new_config.categorical_feature != old_config.categorical_feature) {
      Log::Fatal(
          "Cannot change categorical_feature after constructed Dataset "
          "handle.");
    }
    if (new_param.count("feature_pre_filter") &&
        new_config.feature_pre_filter != old_config.feature_pre_filter) {
      Log::Fatal(
          "Cannot change feature_pre_filter after constructed Dataset handle.");
    }
    if (new_param.count("is_enable_sparse") &&
        new_config.is_enable_sparse != old_config.is_enable_sparse) {
      Log::Fatal(
          "Cannot change is_enable_sparse after constructed Dataset handle.");
    }
    if (new_param.count("pre_partition") &&
        new_config.pre_partition != old_config.pre_partition) {
      Log::Fatal(
          "Cannot change pre_partition after constructed Dataset handle.");
    }
    if (new_param.count("enable_bundle") &&
        new_config.enable_bundle != old_config.enable_bundle) {
      Log::Fatal(
          "Cannot change enable_bundle after constructed Dataset handle.");
    }
    if (new_param.count("header") && new_config.header != old_config.header) {
      Log::Fatal("Cannot change header after constructed Dataset handle.");
    }
    if (new_param.count("two_round") &&
        new_config.two_round != old_config.two_round) {
      Log::Fatal("Cannot change two_round after constructed Dataset handle.");
    }
    if (new_param.count("label_column") &&
        new_config.label_column != old_config.label_column) {
      Log::Fatal(
          "Cannot change label_column after constructed Dataset handle.");
    }
    if (new_param.count("weight_column") &&
        new_config.weight_column != old_config.weight_column) {
      Log::Fatal(
          "Cannot change weight_column after constructed Dataset handle.");
    }
    if (new_param.count("group_column") &&
        new_config.group_column != old_config.group_column) {
      Log::Fatal(
          "Cannot change group_column after constructed Dataset handle.");
    }
    if (new_param.count("ignore_column") &&
        new_config.ignore_column != old_config.ignore_column) {
      Log::Fatal(
          "Cannot change ignore_column after constructed Dataset handle.");
    }
    if (new_param.count("forcedbins_filename")) {
      Log::Fatal("Cannot change forced bins after constructed Dataset handle.");
    }
    if (new_param.count("min_data_in_leaf") &&
        new_config.min_data_in_leaf < old_config.min_data_in_leaf &&
        old_config.feature_pre_filter) {
      Log::Fatal(
          "Reducing `min_data_in_leaf` with `feature_pre_filter=true` may "
          "cause unexpected behaviour "
          "for features that were pre-filtered by the larger "
          "`min_data_in_leaf`.\n"
          "You need to set `feature_pre_filter=false` to dynamically change "
          "the `min_data_in_leaf`.");
    }
Nikita Titov's avatar
Nikita Titov committed
344
    if (new_param.count("linear_tree") && new_config.linear_tree != old_config.linear_tree) {
345
      Log::Fatal("Cannot change linear_tree after constructed Dataset handle.");
346
    }
Nikita Titov's avatar
Nikita Titov committed
347
348
349
350
    if (new_param.count("precise_float_parser") &&
        new_config.precise_float_parser != old_config.precise_float_parser) {
      Log::Fatal("Cannot change precise_float_parser after constructed Dataset handle.");
    }
351
352
  }

wxchan's avatar
wxchan committed
353
  void ResetConfig(const char* parameters) {
354
    UNIQUE_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
355
    auto param = Config::Str2Map(parameters);
356
357
358
    Config new_config;
    new_config.Set(param);
    if (param.count("num_class") && new_config.num_class != config_.num_class) {
359
      Log::Fatal("Cannot change num_class during training");
wxchan's avatar
wxchan committed
360
    }
361
    if (param.count("boosting") && new_config.boosting != config_.boosting) {
Guolin Ke's avatar
Guolin Ke committed
362
      Log::Fatal("Cannot change boosting during training");
wxchan's avatar
wxchan committed
363
    }
364
    if (param.count("metric") && new_config.metric != config_.metric) {
365
      Log::Fatal("Cannot change metric during training");
Guolin Ke's avatar
Guolin Ke committed
366
    }
367
368
    CheckDatasetResetConfig(config_, param);

Guolin Ke's avatar
Guolin Ke committed
369
    config_.Set(param);
370

371
    OMP_SET_NUM_THREADS(config_.num_threads);
Guolin Ke's avatar
Guolin Ke committed
372
373
374

    if (param.count("objective")) {
      // create objective function
Guolin Ke's avatar
Guolin Ke committed
375
376
      objective_fun_.reset(ObjectiveFunction::CreateObjectiveFunction(config_.objective,
                                                                      config_));
Guolin Ke's avatar
Guolin Ke committed
377
      if (objective_fun_ == nullptr) {
378
        Log::Info("Using self-defined objective function");
Guolin Ke's avatar
Guolin Ke committed
379
380
381
382
383
      }
      // initialize the objective function
      if (objective_fun_ != nullptr) {
        objective_fun_->Init(train_data_->metadata(), train_data_->num_data());
      }
384
385
      boosting_->ResetTrainingData(train_data_,
                                   objective_fun_.get(), Common::ConstPtrInVectorWrapper<Metric>(train_metric_));
wxchan's avatar
wxchan committed
386
    }
Guolin Ke's avatar
Guolin Ke committed
387

Guolin Ke's avatar
Guolin Ke committed
388
    boosting_->ResetConfig(&config_);
wxchan's avatar
wxchan committed
389
390
391
  }

  void AddValidData(const Dataset* valid_data) {
392
    UNIQUE_LOCK(mutex_)
wxchan's avatar
wxchan committed
393
    valid_metrics_.emplace_back();
Guolin Ke's avatar
Guolin Ke committed
394
395
    for (auto metric_type : config_.metric) {
      auto metric = std::unique_ptr<Metric>(Metric::CreateMetric(metric_type, config_));
wxchan's avatar
wxchan committed
396
397
398
399
400
401
      if (metric == nullptr) { continue; }
      metric->Init(valid_data->metadata(), valid_data->num_data());
      valid_metrics_.back().push_back(std::move(metric));
    }
    valid_metrics_.back().shrink_to_fit();
    boosting_->AddValidDataset(valid_data,
402
                               Common::ConstPtrInVectorWrapper<Metric>(valid_metrics_.back()));
wxchan's avatar
wxchan committed
403
  }
Guolin Ke's avatar
Guolin Ke committed
404

405
  bool TrainOneIter() {
406
    UNIQUE_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
407
    return boosting_->TrainOneIter(nullptr, nullptr);
408
409
  }

Guolin Ke's avatar
Guolin Ke committed
410
  void Refit(const int32_t* leaf_preds, int32_t nrow, int32_t ncol) {
411
    UNIQUE_LOCK(mutex_)
412
    boosting_->RefitTree(leaf_preds, nrow, ncol);
Guolin Ke's avatar
Guolin Ke committed
413
414
  }

415
  bool TrainOneIter(const score_t* gradients, const score_t* hessians) {
416
    UNIQUE_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
417
    return boosting_->TrainOneIter(gradients, hessians);
418
419
  }

wxchan's avatar
wxchan committed
420
  void RollbackOneIter() {
421
    UNIQUE_LOCK(mutex_)
wxchan's avatar
wxchan committed
422
423
424
    boosting_->RollbackOneIter();
  }

425
  void SetSingleRowPredictorInner(int start_iteration, int num_iteration, int predict_type, const Config& config) {
426
427
428
      UNIQUE_LOCK(mutex_)
      if (single_row_predictor_[predict_type].get() == nullptr ||
          !single_row_predictor_[predict_type]->IsPredictorEqual(config, num_iteration, boosting_.get())) {
429
        single_row_predictor_[predict_type].reset(new SingleRowPredictorInner(predict_type, boosting_.get(),
430
                                                                         config, start_iteration, num_iteration));
431
432
433
      }
  }

434
435
436
437
438
439
440
441
442
443
444
  std::unique_ptr<SingleRowPredictor> InitSingleRowPredictor(int predict_type, int start_iteration, int num_iteration, int data_type, int32_t num_cols, const char *parameters) {
    // Workaround https://github.com/microsoft/LightGBM/issues/6142 by locking here
    // This is only a workaround because if predictors are initialized differently it may still behave incorrectly,
    // and because multiple racing Predictor initializations through LGBM_BoosterPredictForMat suffers from that same issue of Predictor init writing things in the booster.
    // Once #6142 is fixed (predictor doesn't write in the Booster as should have been the case since 1c35c3b9ede9adab8ccc5fd7b4b2b6af188a79f0), this line can be removed.
    UNIQUE_LOCK(mutex_)

    return std::unique_ptr<SingleRowPredictor>(new SingleRowPredictor(
      &mutex_, parameters, data_type, num_cols, predict_type, boosting_.get(), start_iteration, num_iteration));
  }

445
  void PredictSingleRow(int predict_type, int ncol,
446
447
               std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun,
               const Config& config,
448
               double* out_result, int64_t* out_len) const {
449
450
451
    if (!config.predict_disable_shape_check && ncol != boosting_->MaxFeatureIdx() + 1) {
      Log::Fatal("The number of features in data (%d) is not the same as it was in training data (%d).\n"\
                 "You can set ``predict_disable_shape_check=true`` to discard this error, but please be aware what you are doing.", ncol, boosting_->MaxFeatureIdx() + 1);
452
    }
453
    UNIQUE_LOCK(mutex_)
454
    const auto& single_row_predictor = single_row_predictor_[predict_type];
455
456
    auto one_row = get_row_fun(0);
    auto pred_wrt_ptr = out_result;
457
    single_row_predictor->predict_function(one_row, pred_wrt_ptr);
458

459
    *out_len = single_row_predictor->num_pred_in_one_row;
460
461
  }

462
  Predictor CreatePredictor(int start_iteration, int num_iteration, int predict_type, int ncol, const Config& config) const {
463
464
465
    if (!config.predict_disable_shape_check && ncol != boosting_->MaxFeatureIdx() + 1) {
      Log::Fatal("The number of features in data (%d) is not the same as it was in training data (%d).\n" \
                 "You can set ``predict_disable_shape_check=true`` to discard this error, but please be aware what you are doing.", ncol, boosting_->MaxFeatureIdx() + 1);
466
    }
Guolin Ke's avatar
Guolin Ke committed
467
468
    bool is_predict_leaf = false;
    bool is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
469
    bool predict_contrib = false;
Guolin Ke's avatar
Guolin Ke committed
470
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
Guolin Ke's avatar
Guolin Ke committed
471
      is_predict_leaf = true;
Guolin Ke's avatar
Guolin Ke committed
472
    } else if (predict_type == C_API_PREDICT_RAW_SCORE) {
Guolin Ke's avatar
Guolin Ke committed
473
      is_raw_score = true;
474
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
Guolin Ke's avatar
Guolin Ke committed
475
      predict_contrib = true;
Guolin Ke's avatar
Guolin Ke committed
476
477
    } else {
      is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
478
    }
Guolin Ke's avatar
Guolin Ke committed
479

480
    return Predictor(boosting_.get(), start_iteration, num_iteration, is_raw_score, is_predict_leaf, predict_contrib,
481
                        config.pred_early_stop, config.pred_early_stop_freq, config.pred_early_stop_margin);
482
483
  }

484
  void Predict(int start_iteration, int num_iteration, int predict_type, int nrow, int ncol,
485
486
               std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun,
               const Config& config,
487
488
               double* out_result, int64_t* out_len) const {
    SHARED_LOCK(mutex_);
489
    auto predictor = CreatePredictor(start_iteration, num_iteration, predict_type, ncol, config);
490
491
492
493
494
495
496
    bool is_predict_leaf = false;
    bool predict_contrib = false;
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
      is_predict_leaf = true;
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
      predict_contrib = true;
    }
497
    int64_t num_pred_in_one_row = boosting_->NumPredictOneRow(start_iteration, num_iteration, is_predict_leaf, predict_contrib);
Guolin Ke's avatar
Guolin Ke committed
498
    auto pred_fun = predictor.GetPredictFunction();
499
    OMP_INIT_EX();
500
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
Guolin Ke's avatar
Guolin Ke committed
501
    for (int i = 0; i < nrow; ++i) {
502
      OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
503
      auto one_row = get_row_fun(i);
Tony-Y's avatar
Tony-Y committed
504
      auto pred_wrt_ptr = out_result + static_cast<size_t>(num_pred_in_one_row) * i;
Guolin Ke's avatar
Guolin Ke committed
505
      pred_fun(one_row, pred_wrt_ptr);
506
      OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
507
    }
508
    OMP_THROW_EX();
509
    *out_len = num_pred_in_one_row * nrow;
Guolin Ke's avatar
Guolin Ke committed
510
511
  }

512
  void PredictSparse(int start_iteration, int num_iteration, int predict_type, int64_t nrow, int ncol,
513
514
515
516
                     std::function<std::vector<std::pair<int, double>>(int64_t row_idx)> get_row_fun,
                     const Config& config, int64_t* out_elements_size,
                     std::vector<std::vector<std::unordered_map<int, double>>>* agg_ptr,
                     int32_t** out_indices, void** out_data, int data_type,
517
                     bool* is_data_float32_ptr, int num_matrices) const {
518
    auto predictor = CreatePredictor(start_iteration, num_iteration, predict_type, ncol, config);
519
520
521
    auto pred_sparse_fun = predictor.GetPredictSparseFunction();
    std::vector<std::vector<std::unordered_map<int, double>>>& agg = *agg_ptr;
    OMP_INIT_EX();
522
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
    for (int64_t i = 0; i < nrow; ++i) {
      OMP_LOOP_EX_BEGIN();
      auto one_row = get_row_fun(i);
      agg[i] = std::vector<std::unordered_map<int, double>>(num_matrices);
      pred_sparse_fun(one_row, &agg[i]);
      OMP_LOOP_EX_END();
    }
    OMP_THROW_EX();
    // calculate the nonzero data and indices size
    int64_t elements_size = 0;
    for (int64_t i = 0; i < static_cast<int64_t>(agg.size()); ++i) {
      auto row_vector = agg[i];
      for (int j = 0; j < static_cast<int>(row_vector.size()); ++j) {
        elements_size += static_cast<int64_t>(row_vector[j].size());
      }
    }
    *out_elements_size = elements_size;
    *is_data_float32_ptr = false;
    // allocate data and indices arrays
    if (data_type == C_API_DTYPE_FLOAT32) {
      *out_data = new float[elements_size];
      *is_data_float32_ptr = true;
    } else if (data_type == C_API_DTYPE_FLOAT64) {
      *out_data = new double[elements_size];
    } else {
      Log::Fatal("Unknown data type in PredictSparse");
      return;
    }
    *out_indices = new int32_t[elements_size];
  }

554
  void PredictSparseCSR(int start_iteration, int num_iteration, int predict_type, int64_t nrow, int ncol,
555
556
557
                        std::function<std::vector<std::pair<int, double>>(int64_t row_idx)> get_row_fun,
                        const Config& config,
                        int64_t* out_len, void** out_indptr, int indptr_type,
558
559
                        int32_t** out_indices, void** out_data, int data_type) const {
    SHARED_LOCK(mutex_);
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
    // Get the number of trees per iteration (for multiclass scenario we output multiple sparse matrices)
    int num_matrices = boosting_->NumModelPerIteration();
    bool is_indptr_int32 = false;
    bool is_data_float32 = false;
    int64_t indptr_size = (nrow + 1) * num_matrices;
    if (indptr_type == C_API_DTYPE_INT32) {
      *out_indptr = new int32_t[indptr_size];
      is_indptr_int32 = true;
    } else if (indptr_type == C_API_DTYPE_INT64) {
      *out_indptr = new int64_t[indptr_size];
    } else {
      Log::Fatal("Unknown indptr type in PredictSparseCSR");
      return;
    }
    // aggregated per row feature contribution results
    std::vector<std::vector<std::unordered_map<int, double>>> agg(nrow);
    int64_t elements_size = 0;
577
    PredictSparse(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun, config, &elements_size, &agg,
578
579
580
                  out_indices, out_data, data_type, &is_data_float32, num_matrices);
    std::vector<int> row_sizes(num_matrices * nrow);
    std::vector<int64_t> row_matrix_offsets(num_matrices * nrow);
581
    std::vector<int64_t> matrix_offsets(num_matrices);
582
583
584
585
586
587
588
589
590
591
592
593
594
595
    int64_t row_vector_cnt = 0;
    for (int m = 0; m < num_matrices; ++m) {
      for (int64_t i = 0; i < static_cast<int64_t>(agg.size()); ++i) {
        auto row_vector = agg[i];
        auto row_vector_size = row_vector[m].size();
        // keep track of the row_vector sizes for parallelization
        row_sizes[row_vector_cnt] = static_cast<int>(row_vector_size);
        if (i == 0) {
          row_matrix_offsets[row_vector_cnt] = 0;
        } else {
          row_matrix_offsets[row_vector_cnt] = static_cast<int64_t>(row_sizes[row_vector_cnt - 1] + row_matrix_offsets[row_vector_cnt - 1]);
        }
        row_vector_cnt++;
      }
596
597
598
599
600
601
      if (m == 0) {
        matrix_offsets[m] = 0;
      }
      if (m + 1 < num_matrices) {
        matrix_offsets[m + 1] = static_cast<int64_t>(matrix_offsets[m] + row_matrix_offsets[row_vector_cnt - 1] + row_sizes[row_vector_cnt - 1]);
      }
602
603
604
605
606
607
608
609
610
611
612
613
    }
    // copy vector results to output for each row
    int64_t indptr_index = 0;
    for (int m = 0; m < num_matrices; ++m) {
      if (is_indptr_int32) {
        (reinterpret_cast<int32_t*>(*out_indptr))[indptr_index] = 0;
      } else {
        (reinterpret_cast<int64_t*>(*out_indptr))[indptr_index] = 0;
      }
      indptr_index++;
      int64_t matrix_start_index = m * static_cast<int64_t>(agg.size());
      OMP_INIT_EX();
614
      #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
615
616
617
618
      for (int64_t i = 0; i < static_cast<int64_t>(agg.size()); ++i) {
        OMP_LOOP_EX_BEGIN();
        auto row_vector = agg[i];
        int64_t row_start_index = matrix_start_index + i;
619
        int64_t element_index = row_matrix_offsets[row_start_index] + matrix_offsets[m];
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
        int64_t indptr_loop_index = indptr_index + i;
        for (auto it = row_vector[m].begin(); it != row_vector[m].end(); ++it) {
          (*out_indices)[element_index] = it->first;
          if (is_data_float32) {
            (reinterpret_cast<float*>(*out_data))[element_index] = static_cast<float>(it->second);
          } else {
            (reinterpret_cast<double*>(*out_data))[element_index] = it->second;
          }
          element_index++;
        }
        int64_t indptr_value = row_matrix_offsets[row_start_index] + row_sizes[row_start_index];
        if (is_indptr_int32) {
          (reinterpret_cast<int32_t*>(*out_indptr))[indptr_loop_index] = static_cast<int32_t>(indptr_value);
        } else {
          (reinterpret_cast<int64_t*>(*out_indptr))[indptr_loop_index] = indptr_value;
        }
        OMP_LOOP_EX_END();
      }
      OMP_THROW_EX();
      indptr_index += static_cast<int64_t>(agg.size());
    }
    out_len[0] = elements_size;
    out_len[1] = indptr_size;
  }

645
  void PredictSparseCSC(int start_iteration, int num_iteration, int predict_type, int64_t nrow, int ncol,
646
647
648
                        std::function<std::vector<std::pair<int, double>>(int64_t row_idx)> get_row_fun,
                        const Config& config,
                        int64_t* out_len, void** out_col_ptr, int col_ptr_type,
649
650
                        int32_t** out_indices, void** out_data, int data_type) const {
    SHARED_LOCK(mutex_);
651
652
    // Get the number of trees per iteration (for multiclass scenario we output multiple sparse matrices)
    int num_matrices = boosting_->NumModelPerIteration();
653
    auto predictor = CreatePredictor(start_iteration, num_iteration, predict_type, ncol, config);
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
    auto pred_sparse_fun = predictor.GetPredictSparseFunction();
    bool is_col_ptr_int32 = false;
    bool is_data_float32 = false;
    int num_output_cols = ncol + 1;
    int col_ptr_size = (num_output_cols + 1) * num_matrices;
    if (col_ptr_type == C_API_DTYPE_INT32) {
      *out_col_ptr = new int32_t[col_ptr_size];
      is_col_ptr_int32 = true;
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
      *out_col_ptr = new int64_t[col_ptr_size];
    } else {
      Log::Fatal("Unknown col_ptr type in PredictSparseCSC");
      return;
    }
    // aggregated per row feature contribution results
    std::vector<std::vector<std::unordered_map<int, double>>> agg(nrow);
    int64_t elements_size = 0;
671
    PredictSparse(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun, config, &elements_size, &agg,
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
                  out_indices, out_data, data_type, &is_data_float32, num_matrices);
    // calculate number of elements per column to construct
    // the CSC matrix with random access
    std::vector<std::vector<int64_t>> column_sizes(num_matrices);
    for (int m = 0; m < num_matrices; ++m) {
      column_sizes[m] = std::vector<int64_t>(num_output_cols, 0);
      for (int64_t i = 0; i < static_cast<int64_t>(agg.size()); ++i) {
        auto row_vector = agg[i];
        for (auto it = row_vector[m].begin(); it != row_vector[m].end(); ++it) {
          column_sizes[m][it->first] += 1;
        }
      }
    }
    // keep track of column counts
    std::vector<std::vector<int64_t>> column_counts(num_matrices);
    // keep track of beginning index for each column
    std::vector<std::vector<int64_t>> column_start_indices(num_matrices);
    // keep track of beginning index for each matrix
    std::vector<int64_t> matrix_start_indices(num_matrices, 0);
    int col_ptr_index = 0;
    for (int m = 0; m < num_matrices; ++m) {
      int64_t col_ptr_value = 0;
      column_start_indices[m] = std::vector<int64_t>(num_output_cols, 0);
      column_counts[m] = std::vector<int64_t>(num_output_cols, 0);
      if (is_col_ptr_int32) {
        (reinterpret_cast<int32_t*>(*out_col_ptr))[col_ptr_index] = static_cast<int32_t>(col_ptr_value);
      } else {
        (reinterpret_cast<int64_t*>(*out_col_ptr))[col_ptr_index] = col_ptr_value;
      }
      col_ptr_index++;
      for (int64_t i = 1; i < static_cast<int64_t>(column_sizes[m].size()); ++i) {
        column_start_indices[m][i] = column_sizes[m][i - 1] + column_start_indices[m][i - 1];
        if (is_col_ptr_int32) {
          (reinterpret_cast<int32_t*>(*out_col_ptr))[col_ptr_index] = static_cast<int32_t>(column_start_indices[m][i]);
        } else {
          (reinterpret_cast<int64_t*>(*out_col_ptr))[col_ptr_index] = column_start_indices[m][i];
        }
        col_ptr_index++;
      }
      int64_t last_elem_index = static_cast<int64_t>(column_sizes[m].size()) - 1;
      int64_t last_column_start_index = column_start_indices[m][last_elem_index];
      int64_t last_column_size = column_sizes[m][last_elem_index];
      if (is_col_ptr_int32) {
        (reinterpret_cast<int32_t*>(*out_col_ptr))[col_ptr_index] = static_cast<int32_t>(last_column_start_index + last_column_size);
      } else {
        (reinterpret_cast<int64_t*>(*out_col_ptr))[col_ptr_index] = last_column_start_index + last_column_size;
      }
719
720
      if (m + 1 < num_matrices) {
        matrix_start_indices[m + 1] = matrix_start_indices[m] + last_column_start_index + last_column_size;
721
      }
722
      col_ptr_index++;
723
    }
724
725
    // Note: we parallelize across matrices instead of rows because of the column_counts[m][col_idx] increment inside the loop
    OMP_INIT_EX();
726
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
727
    for (int m = 0; m < num_matrices; ++m) {
728
      OMP_LOOP_EX_BEGIN();
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
      for (int64_t i = 0; i < static_cast<int64_t>(agg.size()); ++i) {
        auto row_vector = agg[i];
        for (auto it = row_vector[m].begin(); it != row_vector[m].end(); ++it) {
          int64_t col_idx = it->first;
          int64_t element_index = column_start_indices[m][col_idx] +
            matrix_start_indices[m] +
            column_counts[m][col_idx];
          // store the row index
          (*out_indices)[element_index] = static_cast<int32_t>(i);
          // update column count
          column_counts[m][col_idx]++;
          if (is_data_float32) {
            (reinterpret_cast<float*>(*out_data))[element_index] = static_cast<float>(it->second);
          } else {
            (reinterpret_cast<double*>(*out_data))[element_index] = it->second;
          }
        }
      }
747
      OMP_LOOP_EX_END();
748
    }
749
    OMP_THROW_EX();
750
751
752
753
    out_len[0] = elements_size;
    out_len[1] = col_ptr_size;
  }

754
  void Predict(int start_iteration, int num_iteration, int predict_type, const char* data_filename,
Guolin Ke's avatar
Guolin Ke committed
755
               int data_has_header, const Config& config,
756
757
               const char* result_filename) const {
    SHARED_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
758
759
    bool is_predict_leaf = false;
    bool is_raw_score = false;
Guolin Ke's avatar
Guolin Ke committed
760
    bool predict_contrib = false;
Guolin Ke's avatar
Guolin Ke committed
761
762
763
764
    if (predict_type == C_API_PREDICT_LEAF_INDEX) {
      is_predict_leaf = true;
    } else if (predict_type == C_API_PREDICT_RAW_SCORE) {
      is_raw_score = true;
765
    } else if (predict_type == C_API_PREDICT_CONTRIB) {
Guolin Ke's avatar
Guolin Ke committed
766
      predict_contrib = true;
Guolin Ke's avatar
Guolin Ke committed
767
768
769
    } else {
      is_raw_score = false;
    }
770
    Predictor predictor(boosting_.get(), start_iteration, num_iteration, is_raw_score, is_predict_leaf, predict_contrib,
771
                        config.pred_early_stop, config.pred_early_stop_freq, config.pred_early_stop_margin);
Guolin Ke's avatar
Guolin Ke committed
772
    bool bool_data_has_header = data_has_header > 0 ? true : false;
Chen Yufei's avatar
Chen Yufei committed
773
774
    predictor.Predict(data_filename, result_filename, bool_data_has_header, config.predict_disable_shape_check,
                      config.precise_float_parser);
Guolin Ke's avatar
Guolin Ke committed
775
776
  }

777
  void GetPredictAt(int data_idx, double* out_result, int64_t* out_len) const {
wxchan's avatar
wxchan committed
778
779
780
    boosting_->GetPredictAt(data_idx, out_result, out_len);
  }

781
  void SaveModelToFile(int start_iteration, int num_iteration, int feature_importance_type, const char* filename) const {
782
    boosting_->SaveModelToFile(start_iteration, num_iteration, feature_importance_type, filename);
Guolin Ke's avatar
Guolin Ke committed
783
  }
784

785
  void LoadModelFromString(const char* model_str) {
786
787
    size_t len = std::strlen(model_str);
    boosting_->LoadModelFromString(model_str, len);
788
789
  }

790
  std::string SaveModelToString(int start_iteration, int num_iteration,
791
                                int feature_importance_type) const {
792
793
    return boosting_->SaveModelToString(start_iteration,
                                        num_iteration, feature_importance_type);
794
795
  }

796
  std::string DumpModel(int start_iteration, int num_iteration,
797
                        int feature_importance_type) const {
798
799
    return boosting_->DumpModel(start_iteration, num_iteration,
                                feature_importance_type);
wxchan's avatar
wxchan committed
800
  }
801

802
  std::vector<double> FeatureImportance(int num_iteration, int importance_type) const {
803
804
805
    return boosting_->FeatureImportance(num_iteration, importance_type);
  }

806
  double UpperBoundValue() const {
807
    SHARED_LOCK(mutex_)
808
809
810
811
    return boosting_->GetUpperBoundValue();
  }

  double LowerBoundValue() const {
812
    SHARED_LOCK(mutex_)
813
814
815
    return boosting_->GetLowerBoundValue();
  }

Guolin Ke's avatar
Guolin Ke committed
816
  double GetLeafValue(int tree_idx, int leaf_idx) const {
817
    SHARED_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
818
    return dynamic_cast<GBDTBase*>(boosting_.get())->GetLeafValue(tree_idx, leaf_idx);
Guolin Ke's avatar
Guolin Ke committed
819
820
821
  }

  void SetLeafValue(int tree_idx, int leaf_idx, double val) {
822
    UNIQUE_LOCK(mutex_)
Guolin Ke's avatar
Guolin Ke committed
823
    dynamic_cast<GBDTBase*>(boosting_.get())->SetLeafValue(tree_idx, leaf_idx, val);
Guolin Ke's avatar
Guolin Ke committed
824
825
  }

826
  void ShuffleModels(int start_iter, int end_iter) {
827
    UNIQUE_LOCK(mutex_)
828
    boosting_->ShuffleModels(start_iter, end_iter);
829
830
  }

wxchan's avatar
wxchan committed
831
  int GetEvalCounts() const {
832
    SHARED_LOCK(mutex_)
wxchan's avatar
wxchan committed
833
834
835
836
837
838
    int ret = 0;
    for (const auto& metric : train_metric_) {
      ret += static_cast<int>(metric->GetName().size());
    }
    return ret;
  }
839

840
  int GetEvalNames(char** out_strs, const int len, const size_t buffer_len, size_t *out_buffer_len) const {
841
    SHARED_LOCK(mutex_)
842
    *out_buffer_len = 0;
wxchan's avatar
wxchan committed
843
844
845
    int idx = 0;
    for (const auto& metric : train_metric_) {
      for (const auto& name : metric->GetName()) {
846
847
848
849
850
        if (idx < len) {
          std::memcpy(out_strs[idx], name.c_str(), std::min(name.size() + 1, buffer_len));
          out_strs[idx][buffer_len - 1] = '\0';
        }
        *out_buffer_len = std::max(name.size() + 1, *out_buffer_len);
wxchan's avatar
wxchan committed
851
852
853
854
855
856
        ++idx;
      }
    }
    return idx;
  }

857
  int GetFeatureNames(char** out_strs, const int len, const size_t buffer_len, size_t *out_buffer_len) const {
858
    SHARED_LOCK(mutex_)
859
    *out_buffer_len = 0;
wxchan's avatar
wxchan committed
860
861
    int idx = 0;
    for (const auto& name : boosting_->FeatureNames()) {
862
863
864
865
866
      if (idx < len) {
        std::memcpy(out_strs[idx], name.c_str(), std::min(name.size() + 1, buffer_len));
        out_strs[idx][buffer_len - 1] = '\0';
      }
      *out_buffer_len = std::max(name.size() + 1, *out_buffer_len);
wxchan's avatar
wxchan committed
867
868
869
870
871
      ++idx;
    }
    return idx;
  }

wxchan's avatar
wxchan committed
872
  const Boosting* GetBoosting() const { return boosting_.get(); }
Guolin Ke's avatar
Guolin Ke committed
873

Nikita Titov's avatar
Nikita Titov committed
874
 private:
wxchan's avatar
wxchan committed
875
  const Dataset* train_data_;
Guolin Ke's avatar
Guolin Ke committed
876
  std::unique_ptr<Boosting> boosting_;
877
  std::unique_ptr<SingleRowPredictorInner> single_row_predictor_[PREDICTOR_TYPES];
878

Guolin Ke's avatar
Guolin Ke committed
879
  /*! \brief All configs */
Guolin Ke's avatar
Guolin Ke committed
880
  Config config_;
Guolin Ke's avatar
Guolin Ke committed
881
  /*! \brief Metric for training data */
Guolin Ke's avatar
Guolin Ke committed
882
  std::vector<std::unique_ptr<Metric>> train_metric_;
Guolin Ke's avatar
Guolin Ke committed
883
  /*! \brief Metrics for validation data */
Guolin Ke's avatar
Guolin Ke committed
884
  std::vector<std::vector<std::unique_ptr<Metric>>> valid_metrics_;
Guolin Ke's avatar
Guolin Ke committed
885
  /*! \brief Training objective function */
Guolin Ke's avatar
Guolin Ke committed
886
  std::unique_ptr<ObjectiveFunction> objective_fun_;
wxchan's avatar
wxchan committed
887
  /*! \brief mutex for threading safe call */
888
  mutable yamc::alternate::shared_mutex mutex_;
Guolin Ke's avatar
Guolin Ke committed
889
890
};

891
}  // namespace LightGBM
Guolin Ke's avatar
Guolin Ke committed
892

893
894
// explicitly declare symbols from LightGBM namespace
using LightGBM::AllgatherFunction;
895
using LightGBM::ArrowChunkedArray;
896
using LightGBM::ArrowTable;
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
using LightGBM::Booster;
using LightGBM::Common::CheckElementsIntervalClosed;
using LightGBM::Common::RemoveQuotationSymbol;
using LightGBM::Common::Vector2Ptr;
using LightGBM::Common::VectorSize;
using LightGBM::Config;
using LightGBM::data_size_t;
using LightGBM::Dataset;
using LightGBM::DatasetLoader;
using LightGBM::kZeroThreshold;
using LightGBM::LGBM_APIHandleException;
using LightGBM::Log;
using LightGBM::Network;
using LightGBM::Random;
using LightGBM::ReduceScatterFunction;
912
using LightGBM::SingleRowPredictor;
Guolin Ke's avatar
Guolin Ke committed
913

Guolin Ke's avatar
Guolin Ke committed
914
915
916
917
918
919
920
921
// some help functions used to convert data

std::function<std::vector<double>(int row_idx)>
RowFunctionFromDenseMatric(const void* data, int num_row, int num_col, int data_type, int is_row_major);

std::function<std::vector<std::pair<int, double>>(int row_idx)>
RowPairFunctionFromDenseMatric(const void* data, int num_row, int num_col, int data_type, int is_row_major);

922
923
924
std::function<std::vector<std::pair<int, double>>(int row_idx)>
RowPairFunctionFromDenseRows(const void** data, int num_col, int data_type);

925
926
template<typename T>
std::function<std::vector<std::pair<int, double>>(T idx)>
Guolin Ke's avatar
Guolin Ke committed
927
RowFunctionFromCSR(const void* indptr, int indptr_type, const int32_t* indices,
928
                   const void* data, int data_type, int64_t nindptr, int64_t nelem);
Guolin Ke's avatar
Guolin Ke committed
929
930
931

// Row iterator of on column for CSC matrix
class CSC_RowIterator {
Nikita Titov's avatar
Nikita Titov committed
932
 public:
Guolin Ke's avatar
Guolin Ke committed
933
  CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
934
                  const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx);
Guolin Ke's avatar
Guolin Ke committed
935
936
937
938
939
  ~CSC_RowIterator() {}
  // return value at idx, only can access by ascent order
  double Get(int idx);
  // return next non-zero pair, if index < 0, means no more data
  std::pair<int, double> NextNonZero();
Nikita Titov's avatar
Nikita Titov committed
940
941

 private:
Guolin Ke's avatar
Guolin Ke committed
942
943
944
945
946
947
948
949
950
  int nonzero_idx_ = 0;
  int cur_idx_ = -1;
  double cur_val_ = 0.0f;
  bool is_end_ = false;
  std::function<std::pair<int, double>(int idx)> iter_fun_;
};

// start of c_api functions

Guolin Ke's avatar
Guolin Ke committed
951
const char* LGBM_GetLastError() {
wxchan's avatar
wxchan committed
952
  return LastErrorMsg();
Guolin Ke's avatar
Guolin Ke committed
953
954
}

955
956
957
958
959
960
961
962
963
964
965
966
int LGBM_DumpParamAliases(int64_t buffer_len,
                          int64_t* out_len,
                          char* out_str) {
  API_BEGIN();
  std::string aliases = Config::DumpAliases();
  *out_len = static_cast<int64_t>(aliases.size()) + 1;
  if (*out_len <= buffer_len) {
    std::memcpy(out_str, aliases.c_str(), *out_len);
  }
  API_END();
}

967
968
969
970
971
972
int LGBM_RegisterLogCallback(void (*callback)(const char*)) {
  API_BEGIN();
  Log::ResetCallBack(callback);
  API_END();
}

973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
static inline int SampleCount(int32_t total_nrow, const Config& config) {
  return static_cast<int>(total_nrow < config.bin_construct_sample_cnt ? total_nrow : config.bin_construct_sample_cnt);
}

static inline std::vector<int32_t> CreateSampleIndices(int32_t total_nrow, const Config& config) {
  Random rand(config.data_random_seed);
  int sample_cnt = SampleCount(total_nrow, config);
  return rand.Sample(total_nrow, sample_cnt);
}

int LGBM_GetSampleCount(int32_t num_total_row,
                        const char* parameters,
                        int* out) {
  API_BEGIN();
  if (out == nullptr) {
    Log::Fatal("LGBM_GetSampleCount output is nullptr");
  }
  auto param = Config::Str2Map(parameters);
  Config config;
  config.Set(param);

  *out = SampleCount(num_total_row, config);
  API_END();
}

int LGBM_SampleIndices(int32_t num_total_row,
                       const char* parameters,
                       void* out,
                       int32_t* out_len) {
  // This API is to keep python binding's behavior the same with C++ implementation.
  // Sample count, random seed etc. should be provided in parameters.
  API_BEGIN();
  if (out == nullptr) {
    Log::Fatal("LGBM_SampleIndices output is nullptr");
  }
  auto param = Config::Str2Map(parameters);
  Config config;
  config.Set(param);

  auto sample_indices = CreateSampleIndices(num_total_row, config);
  memcpy(out, sample_indices.data(), sizeof(int32_t) * sample_indices.size());
  *out_len = static_cast<int32_t>(sample_indices.size());
  API_END();
}

1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
int LGBM_ByteBufferGetAt(ByteBufferHandle handle, int32_t index, uint8_t* out_val) {
  API_BEGIN();
  LightGBM::ByteBuffer* byteBuffer = reinterpret_cast<LightGBM::ByteBuffer*>(handle);
  *out_val = byteBuffer->GetAt(index);
  API_END();
}

int LGBM_ByteBufferFree(ByteBufferHandle handle) {
  API_BEGIN();
  delete reinterpret_cast<LightGBM::ByteBuffer*>(handle);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1031
int LGBM_DatasetCreateFromFile(const char* filename,
1032
1033
1034
                               const char* parameters,
                               const DatasetHandle reference,
                               DatasetHandle* out) {
1035
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1036
1037
  auto param = Config::Str2Map(parameters);
  Config config;
1038
  config.Set(param);
1039
  OMP_SET_NUM_THREADS(config.num_threads);
1040
  DatasetLoader loader(config, nullptr, 1, filename);
Guolin Ke's avatar
Guolin Ke committed
1041
  if (reference == nullptr) {
1042
    if (Network::num_machines() == 1) {
1043
      *out = loader.LoadFromFile(filename);
1044
    } else {
1045
      *out = loader.LoadFromFile(filename, Network::rank(), Network::num_machines());
1046
    }
Guolin Ke's avatar
Guolin Ke committed
1047
  } else {
1048
    *out = loader.LoadFromFileAlignWithOtherDataset(filename,
1049
                                                    reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
1050
  }
1051
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1052
1053
}

Guolin Ke's avatar
Guolin Ke committed
1054
int LGBM_DatasetCreateFromSampledColumn(double** sample_data,
1055
1056
1057
1058
                                        int** sample_indices,
                                        int32_t ncol,
                                        const int* num_per_col,
                                        int32_t num_sample_row,
1059
1060
                                        int32_t num_local_row,
                                        int64_t num_dist_row,
1061
1062
                                        const char* parameters,
                                        DatasetHandle* out) {
1063
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1064
1065
  auto param = Config::Str2Map(parameters);
  Config config;
1066
  config.Set(param);
1067
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
1068
  DatasetLoader loader(config, nullptr, 1, nullptr);
1069
1070
1071
1072
  *out = loader.ConstructFromSampleData(sample_data,
                                        sample_indices,
                                        ncol,
                                        num_per_col,
1073
                                        num_sample_row,
1074
1075
                                        static_cast<data_size_t>(num_local_row),
                                        num_dist_row);
1076
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1077
1078
}

Guolin Ke's avatar
Guolin Ke committed
1079
int LGBM_DatasetCreateByReference(const DatasetHandle reference,
1080
1081
                                  int64_t num_total_row,
                                  DatasetHandle* out) {
Guolin Ke's avatar
Guolin Ke committed
1082
1083
  API_BEGIN();
  std::unique_ptr<Dataset> ret;
1084
1085
1086
1087
1088
  data_size_t nrows = static_cast<data_size_t>(num_total_row);
  ret.reset(new Dataset(nrows));
  const Dataset* reference_dataset = reinterpret_cast<const Dataset*>(reference);
  ret->CreateValid(reference_dataset);
  ret->InitByReference(nrows, reference_dataset);
Guolin Ke's avatar
Guolin Ke committed
1089
1090
1091
1092
  *out = ret.release();
  API_END();
}

1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
int LGBM_DatasetCreateFromSerializedReference(const void* ref_buffer,
                                              int32_t ref_buffer_size,
                                              int64_t num_row,
                                              int32_t num_classes,
                                              const char* parameters,
                                              DatasetHandle* out) {
  API_BEGIN();
  auto param = Config::Str2Map(parameters);
  Config config;
  config.Set(param);
  OMP_SET_NUM_THREADS(config.num_threads);
  DatasetLoader loader(config, nullptr, 1, nullptr);
  *out = loader.LoadFromSerializedReference(static_cast<const char*>(ref_buffer),
    static_cast<size_t>(ref_buffer_size),
    static_cast<data_size_t>(num_row),
    num_classes);
  API_END();
}

1112
1113
1114
1115
1116
int LGBM_DatasetInitStreaming(DatasetHandle dataset,
                              int32_t has_weights,
                              int32_t has_init_scores,
                              int32_t has_queries,
                              int32_t nclasses,
1117
1118
                              int32_t nthreads,
                              int32_t omp_max_threads) {
1119
1120
1121
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto num_data = p_dataset->num_data();
1122
  p_dataset->InitStreaming(num_data, has_weights, has_init_scores, has_queries, nclasses, nthreads, omp_max_threads);
1123
1124
1125
1126
  p_dataset->set_wait_for_manual_finish(true);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1127
int LGBM_DatasetPushRows(DatasetHandle dataset,
1128
1129
1130
1131
1132
                         const void* data,
                         int data_type,
                         int32_t nrow,
                         int32_t ncol,
                         int32_t start_row) {
Guolin Ke's avatar
Guolin Ke committed
1133
1134
1135
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto get_row_fun = RowFunctionFromDenseMatric(data, nrow, ncol, data_type, 1);
1136
1137
1138
  if (p_dataset->has_raw()) {
    p_dataset->ResizeRaw(p_dataset->num_numeric_features() + nrow);
  }
1139
  OMP_INIT_EX();
1140
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
Guolin Ke's avatar
Guolin Ke committed
1141
  for (int i = 0; i < nrow; ++i) {
1142
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1143
1144
1145
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(tid, start_row + i, one_row);
1146
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1147
  }
1148
  OMP_THROW_EX();
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
  if (!p_dataset->wait_for_manual_finish() && (start_row + nrow == p_dataset->num_data())) {
    p_dataset->FinishLoad();
  }
  API_END();
}

int LGBM_DatasetPushRowsWithMetadata(DatasetHandle dataset,
                                     const void* data,
                                     int data_type,
                                     int32_t nrow,
                                     int32_t ncol,
                                     int32_t start_row,
                                     const float* labels,
                                     const float* weights,
                                     const double* init_scores,
                                     const int32_t* queries,
                                     int32_t tid) {
  API_BEGIN();
#ifdef LABEL_T_USE_DOUBLE
  Log::Fatal("Don't support LABEL_T_USE_DOUBLE");
#endif
  if (!data) {
    Log::Fatal("data cannot be null.");
  }
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto get_row_fun = RowFunctionFromDenseMatric(data, nrow, ncol, data_type, 1);
  if (p_dataset->has_raw()) {
    p_dataset->ResizeRaw(p_dataset->num_numeric_features() + nrow);
  }

1179
1180
  const int max_omp_threads = p_dataset->omp_max_threads() > 0 ? p_dataset->omp_max_threads() : OMP_NUM_THREADS();

1181
  OMP_INIT_EX();
1182
#pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
1183
1184
1185
  for (int i = 0; i < nrow; ++i) {
    OMP_LOOP_EX_BEGIN();
    // convert internal thread id to be unique based on external thread id
1186
    const int internal_tid = omp_get_thread_num() + (max_omp_threads * tid);
1187
1188
1189
1190
1191
1192
1193
1194
1195
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(internal_tid, start_row + i, one_row);
    OMP_LOOP_EX_END();
  }
  OMP_THROW_EX();

  p_dataset->InsertMetadataAt(start_row, nrow, labels, weights, init_scores, queries);

  if (!p_dataset->wait_for_manual_finish() && (start_row + nrow == p_dataset->num_data())) {
Guolin Ke's avatar
Guolin Ke committed
1196
1197
1198
1199
1200
    p_dataset->FinishLoad();
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1201
int LGBM_DatasetPushRowsByCSR(DatasetHandle dataset,
1202
1203
1204
1205
1206
1207
1208
1209
1210
                              const void* indptr,
                              int indptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t nindptr,
                              int64_t nelem,
                              int64_t,
                              int64_t start_row) {
Guolin Ke's avatar
Guolin Ke committed
1211
1212
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
1213
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
1214
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
1215
1216
1217
  if (p_dataset->has_raw()) {
    p_dataset->ResizeRaw(p_dataset->num_numeric_features() + nrow);
  }
1218
  OMP_INIT_EX();
1219
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
Guolin Ke's avatar
Guolin Ke committed
1220
  for (int i = 0; i < nrow; ++i) {
1221
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1222
1223
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
1224
    p_dataset->PushOneRow(tid, static_cast<data_size_t>(start_row + i), one_row);
1225
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1226
  }
1227
  OMP_THROW_EX();
1228
  if (!p_dataset->wait_for_manual_finish() && (start_row + nrow == static_cast<int64_t>(p_dataset->num_data()))) {
Guolin Ke's avatar
Guolin Ke committed
1229
1230
    p_dataset->FinishLoad();
  }
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
  API_END();
}

int LGBM_DatasetPushRowsByCSRWithMetadata(DatasetHandle dataset,
                                          const void* indptr,
                                          int indptr_type,
                                          const int32_t* indices,
                                          const void* data,
                                          int data_type,
                                          int64_t nindptr,
                                          int64_t nelem,
                                          int64_t start_row,
                                          const float* labels,
                                          const float* weights,
                                          const double* init_scores,
                                          const int32_t* queries,
                                          int32_t tid) {
  API_BEGIN();
#ifdef LABEL_T_USE_DOUBLE
  Log::Fatal("Don't support LABEL_T_USE_DOUBLE");
#endif
  if (!data) {
    Log::Fatal("data cannot be null.");
  }
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
  if (p_dataset->has_raw()) {
    p_dataset->ResizeRaw(p_dataset->num_numeric_features() + nrow);
  }
1261
1262
1263

  const int max_omp_threads = p_dataset->omp_max_threads() > 0 ? p_dataset->omp_max_threads() : OMP_NUM_THREADS();

1264
  OMP_INIT_EX();
1265
#pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
1266
1267
1268
  for (int i = 0; i < nrow; ++i) {
    OMP_LOOP_EX_BEGIN();
    // convert internal thread id to be unique based on external thread id
1269
    const int internal_tid = omp_get_thread_num() + (max_omp_threads * tid);
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
    auto one_row = get_row_fun(i);
    p_dataset->PushOneRow(internal_tid, static_cast<data_size_t>(start_row + i), one_row);
    OMP_LOOP_EX_END();
  }
  OMP_THROW_EX();

  p_dataset->InsertMetadataAt(static_cast<int32_t>(start_row), nrow, labels, weights, init_scores, queries);

  if (!p_dataset->wait_for_manual_finish() && (start_row + nrow == static_cast<int64_t>(p_dataset->num_data()))) {
    p_dataset->FinishLoad();
  }
  API_END();
}

int LGBM_DatasetSetWaitForManualFinish(DatasetHandle dataset, int wait) {
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  p_dataset->set_wait_for_manual_finish(wait);
  API_END();
}

int LGBM_DatasetMarkFinished(DatasetHandle dataset) {
  API_BEGIN();
  auto p_dataset = reinterpret_cast<Dataset*>(dataset);
  p_dataset->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1295
1296
1297
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1298
int LGBM_DatasetCreateFromMat(const void* data,
1299
1300
1301
1302
1303
1304
1305
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              const char* parameters,
                              const DatasetHandle reference,
                              DatasetHandle* out) {
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
  return LGBM_DatasetCreateFromMats(1,
                                    &data,
                                    data_type,
                                    &nrow,
                                    ncol,
                                    is_row_major,
                                    parameters,
                                    reference,
                                    out);
}

int LGBM_DatasetCreateFromMats(int32_t nmat,
                               const void** data,
                               int data_type,
                               int32_t* nrow,
                               int32_t ncol,
                               int is_row_major,
                               const char* parameters,
                               const DatasetHandle reference,
                               DatasetHandle* out) {
1326
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1327
1328
  auto param = Config::Str2Map(parameters);
  Config config;
1329
  config.Set(param);
1330
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
1331
  std::unique_ptr<Dataset> ret;
1332
1333
1334
1335
1336
1337
1338
1339
1340
  int32_t total_nrow = 0;
  for (int j = 0; j < nmat; ++j) {
    total_nrow += nrow[j];
  }

  std::vector<std::function<std::vector<double>(int row_idx)>> get_row_fun;
  for (int j = 0; j < nmat; ++j) {
    get_row_fun.push_back(RowFunctionFromDenseMatric(data[j], nrow[j], ncol, data_type, is_row_major));
  }
1341

Guolin Ke's avatar
Guolin Ke committed
1342
1343
  if (reference == nullptr) {
    // sample data first
1344
1345
    auto sample_indices = CreateSampleIndices(total_nrow, config);
    int sample_cnt = static_cast<int>(sample_indices.size());
1346
    std::vector<std::vector<double>> sample_values(ncol);
Guolin Ke's avatar
Guolin Ke committed
1347
    std::vector<std::vector<int>> sample_idx(ncol);
1348
1349
1350

    int offset = 0;
    int j = 0;
Guolin Ke's avatar
Guolin Ke committed
1351
    for (size_t i = 0; i < sample_indices.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
1352
      auto idx = sample_indices[i];
1353
1354
1355
1356
      while ((idx - offset) >= nrow[j]) {
        offset += nrow[j];
        ++j;
      }
1357

1358
1359
1360
1361
1362
      auto row = get_row_fun[j](static_cast<int>(idx - offset));
      for (size_t k = 0; k < row.size(); ++k) {
        if (std::fabs(row[k]) > kZeroThreshold || std::isnan(row[k])) {
          sample_values[k].emplace_back(row[k]);
          sample_idx[k].emplace_back(static_cast<int>(i));
Guolin Ke's avatar
Guolin Ke committed
1363
        }
Guolin Ke's avatar
Guolin Ke committed
1364
1365
      }
    }
Guolin Ke's avatar
Guolin Ke committed
1366
    DatasetLoader loader(config, nullptr, 1, nullptr);
1367
1368
1369
1370
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             ncol,
                                             VectorSize<double>(sample_values).data(),
1371
1372
1373
                                             sample_cnt,
                                             total_nrow,
                                             total_nrow));
Guolin Ke's avatar
Guolin Ke committed
1374
  } else {
1375
    ret.reset(new Dataset(total_nrow));
Guolin Ke's avatar
Guolin Ke committed
1376
    ret->CreateValid(
1377
      reinterpret_cast<const Dataset*>(reference));
1378
1379
1380
    if (ret->has_raw()) {
      ret->ResizeRaw(total_nrow);
    }
Guolin Ke's avatar
Guolin Ke committed
1381
  }
1382
1383
1384
  int32_t start_row = 0;
  for (int j = 0; j < nmat; ++j) {
    OMP_INIT_EX();
1385
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
    for (int i = 0; i < nrow[j]; ++i) {
      OMP_LOOP_EX_BEGIN();
      const int tid = omp_get_thread_num();
      auto one_row = get_row_fun[j](i);
      ret->PushOneRow(tid, start_row + i, one_row);
      OMP_LOOP_EX_END();
    }
    OMP_THROW_EX();

    start_row += nrow[j];
Guolin Ke's avatar
Guolin Ke committed
1396
1397
  }
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1398
  *out = ret.release();
1399
  API_END();
1400
1401
}

Guolin Ke's avatar
Guolin Ke committed
1402
int LGBM_DatasetCreateFromCSR(const void* indptr,
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
                              int indptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t nindptr,
                              int64_t nelem,
                              int64_t num_col,
                              const char* parameters,
                              const DatasetHandle reference,
                              DatasetHandle* out) {
1413
  API_BEGIN();
1414
1415
1416
1417
1418
  if (num_col <= 0) {
    Log::Fatal("The number of columns should be greater than zero.");
  } else if (num_col >= INT32_MAX) {
    Log::Fatal("The number of columns should be smaller than INT32_MAX.");
  }
Guolin Ke's avatar
Guolin Ke committed
1419
1420
  auto param = Config::Str2Map(parameters);
  Config config;
1421
  config.Set(param);
1422
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
1423
  std::unique_ptr<Dataset> ret;
1424
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
1425
1426
1427
  int32_t nrow = static_cast<int32_t>(nindptr - 1);
  if (reference == nullptr) {
    // sample data first
1428
1429
    auto sample_indices = CreateSampleIndices(nrow, config);
    int sample_cnt = static_cast<int>(sample_indices.size());
Guolin Ke's avatar
Guolin Ke committed
1430
1431
    std::vector<std::vector<double>> sample_values(num_col);
    std::vector<std::vector<int>> sample_idx(num_col);
1432
1433
1434
1435
    for (size_t i = 0; i < sample_indices.size(); ++i) {
      auto idx = sample_indices[i];
      auto row = get_row_fun(static_cast<int>(idx));
      for (std::pair<int, double>& inner_data : row) {
Nikita Titov's avatar
Nikita Titov committed
1436
        CHECK_LT(inner_data.first, num_col);
Guolin Ke's avatar
Guolin Ke committed
1437
        if (std::fabs(inner_data.second) > kZeroThreshold || std::isnan(inner_data.second)) {
Guolin Ke's avatar
Guolin Ke committed
1438
1439
          sample_values[inner_data.first].emplace_back(inner_data.second);
          sample_idx[inner_data.first].emplace_back(static_cast<int>(i));
1440
1441
1442
        }
      }
    }
Guolin Ke's avatar
Guolin Ke committed
1443
    DatasetLoader loader(config, nullptr, 1, nullptr);
1444
1445
1446
1447
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             static_cast<int>(num_col),
                                             VectorSize<double>(sample_values).data(),
1448
1449
1450
                                             sample_cnt,
                                             nrow,
                                             nrow));
1451
  } else {
1452
    ret.reset(new Dataset(nrow));
Guolin Ke's avatar
Guolin Ke committed
1453
    ret->CreateValid(
1454
      reinterpret_cast<const Dataset*>(reference));
1455
1456
1457
    if (ret->has_raw()) {
      ret->ResizeRaw(nrow);
    }
1458
  }
1459
  OMP_INIT_EX();
1460
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
1461
  for (int i = 0; i < static_cast<int>(nindptr - 1); ++i) {
1462
    OMP_LOOP_EX_BEGIN();
1463
1464
1465
    const int tid = omp_get_thread_num();
    auto one_row = get_row_fun(i);
    ret->PushOneRow(tid, i, one_row);
1466
    OMP_LOOP_EX_END();
1467
  }
1468
  OMP_THROW_EX();
1469
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1470
  *out = ret.release();
1471
  API_END();
1472
1473
}

1474
int LGBM_DatasetCreateFromCSRFunc(void* get_row_funptr,
1475
1476
1477
1478
1479
                                  int num_rows,
                                  int64_t num_col,
                                  const char* parameters,
                                  const DatasetHandle reference,
                                  DatasetHandle* out) {
1480
  API_BEGIN();
1481
1482
1483
1484
1485
  if (num_col <= 0) {
    Log::Fatal("The number of columns should be greater than zero.");
  } else if (num_col >= INT32_MAX) {
    Log::Fatal("The number of columns should be smaller than INT32_MAX.");
  }
1486
1487
1488
1489
  auto get_row_fun = *static_cast<std::function<void(int idx, std::vector<std::pair<int, double>>&)>*>(get_row_funptr);
  auto param = Config::Str2Map(parameters);
  Config config;
  config.Set(param);
1490
  OMP_SET_NUM_THREADS(config.num_threads);
1491
1492
1493
1494
  std::unique_ptr<Dataset> ret;
  int32_t nrow = num_rows;
  if (reference == nullptr) {
    // sample data first
1495
1496
    auto sample_indices = CreateSampleIndices(nrow, config);
    int sample_cnt = static_cast<int>(sample_indices.size());
1497
1498
1499
1500
1501
1502
1503
1504
    std::vector<std::vector<double>> sample_values(num_col);
    std::vector<std::vector<int>> sample_idx(num_col);
    // local buffer to re-use memory
    std::vector<std::pair<int, double>> buffer;
    for (size_t i = 0; i < sample_indices.size(); ++i) {
      auto idx = sample_indices[i];
      get_row_fun(static_cast<int>(idx), buffer);
      for (std::pair<int, double>& inner_data : buffer) {
Nikita Titov's avatar
Nikita Titov committed
1505
        CHECK_LT(inner_data.first, num_col);
1506
1507
1508
1509
1510
1511
1512
        if (std::fabs(inner_data.second) > kZeroThreshold || std::isnan(inner_data.second)) {
          sample_values[inner_data.first].emplace_back(inner_data.second);
          sample_idx[inner_data.first].emplace_back(static_cast<int>(i));
        }
      }
    }
    DatasetLoader loader(config, nullptr, 1, nullptr);
1513
1514
1515
1516
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             static_cast<int>(num_col),
                                             VectorSize<double>(sample_values).data(),
1517
1518
1519
                                             sample_cnt,
                                             nrow,
                                             nrow));
1520
1521
1522
1523
  } else {
    ret.reset(new Dataset(nrow));
    ret->CreateValid(
      reinterpret_cast<const Dataset*>(reference));
1524
1525
1526
    if (ret->has_raw()) {
      ret->ResizeRaw(nrow);
    }
1527
  }
1528

1529
  OMP_INIT_EX();
Guolin Ke's avatar
Guolin Ke committed
1530
  std::vector<std::pair<int, double>> thread_buffer;
1531
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static) private(thread_buffer)
1532
1533
1534
  for (int i = 0; i < num_rows; ++i) {
    OMP_LOOP_EX_BEGIN();
    {
1535
      const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
1536
1537
      get_row_fun(i, thread_buffer);
      ret->PushOneRow(tid, i, thread_buffer);
1538
1539
1540
1541
1542
1543
1544
1545
1546
    }
    OMP_LOOP_EX_END();
  }
  OMP_THROW_EX();
  ret->FinishLoad();
  *out = ret.release();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1547
int LGBM_DatasetCreateFromCSC(const void* col_ptr,
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
                              int col_ptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t ncol_ptr,
                              int64_t nelem,
                              int64_t num_row,
                              const char* parameters,
                              const DatasetHandle reference,
                              DatasetHandle* out) {
1558
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1559
1560
  auto param = Config::Str2Map(parameters);
  Config config;
1561
  config.Set(param);
1562
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
1563
  std::unique_ptr<Dataset> ret;
Guolin Ke's avatar
Guolin Ke committed
1564
1565
1566
  int32_t nrow = static_cast<int32_t>(num_row);
  if (reference == nullptr) {
    // sample data first
1567
1568
    auto sample_indices = CreateSampleIndices(nrow, config);
    int sample_cnt = static_cast<int>(sample_indices.size());
Guolin Ke's avatar
Guolin Ke committed
1569
    std::vector<std::vector<double>> sample_values(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
1570
    std::vector<std::vector<int>> sample_idx(ncol_ptr - 1);
1571
    OMP_INIT_EX();
1572
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
Guolin Ke's avatar
Guolin Ke committed
1573
    for (int i = 0; i < static_cast<int>(sample_values.size()); ++i) {
1574
      OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1575
1576
1577
      CSC_RowIterator col_it(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem, i);
      for (int j = 0; j < sample_cnt; j++) {
        auto val = col_it.Get(sample_indices[j]);
Guolin Ke's avatar
Guolin Ke committed
1578
        if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
Guolin Ke's avatar
Guolin Ke committed
1579
1580
          sample_values[i].emplace_back(val);
          sample_idx[i].emplace_back(j);
Guolin Ke's avatar
Guolin Ke committed
1581
1582
        }
      }
1583
      OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1584
    }
1585
    OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
1586
    DatasetLoader loader(config, nullptr, 1, nullptr);
1587
1588
1589
1590
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             static_cast<int>(sample_values.size()),
                                             VectorSize<double>(sample_values).data(),
1591
1592
1593
                                             sample_cnt,
                                             nrow,
                                             nrow));
Guolin Ke's avatar
Guolin Ke committed
1594
  } else {
1595
    ret.reset(new Dataset(nrow));
Guolin Ke's avatar
Guolin Ke committed
1596
    ret->CreateValid(
1597
      reinterpret_cast<const Dataset*>(reference));
Guolin Ke's avatar
Guolin Ke committed
1598
  }
1599
  OMP_INIT_EX();
1600
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
1601
  for (int i = 0; i < static_cast<int>(ncol_ptr - 1); ++i) {
1602
    OMP_LOOP_EX_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1603
    const int tid = omp_get_thread_num();
Guolin Ke's avatar
Guolin Ke committed
1604
    int feature_idx = ret->InnerFeatureIndex(i);
Guolin Ke's avatar
Guolin Ke committed
1605
    if (feature_idx < 0) { continue; }
Guolin Ke's avatar
Guolin Ke committed
1606
1607
    int group = ret->Feature2Group(feature_idx);
    int sub_feature = ret->Feture2SubFeature(feature_idx);
Guolin Ke's avatar
Guolin Ke committed
1608
    CSC_RowIterator col_it(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem, i);
Guolin Ke's avatar
Guolin Ke committed
1609
1610
1611
1612
1613
1614
1615
1616
    auto bin_mapper = ret->FeatureBinMapper(feature_idx);
    if (bin_mapper->GetDefaultBin() == bin_mapper->GetMostFreqBin()) {
      int row_idx = 0;
      while (row_idx < nrow) {
        auto pair = col_it.NextNonZero();
        row_idx = pair.first;
        // no more data
        if (row_idx < 0) { break; }
1617
        ret->PushOneData(tid, row_idx, group, feature_idx, sub_feature, pair.second);
Guolin Ke's avatar
Guolin Ke committed
1618
1619
1620
1621
      }
    } else {
      for (int row_idx = 0; row_idx < nrow; ++row_idx) {
        auto val = col_it.Get(row_idx);
1622
        ret->PushOneData(tid, row_idx, group, feature_idx, sub_feature, val);
Guolin Ke's avatar
Guolin Ke committed
1623
      }
Guolin Ke's avatar
Guolin Ke committed
1624
    }
1625
    OMP_LOOP_EX_END();
Guolin Ke's avatar
Guolin Ke committed
1626
  }
1627
  OMP_THROW_EX();
Guolin Ke's avatar
Guolin Ke committed
1628
  ret->FinishLoad();
Guolin Ke's avatar
Guolin Ke committed
1629
  *out = ret.release();
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
  API_END();
}

int LGBM_DatasetCreateFromArrow(int64_t n_chunks,
                                const ArrowArray* chunks,
                                const ArrowSchema* schema,
                                const char* parameters,
                                const DatasetHandle reference,
                                DatasetHandle *out) {
  API_BEGIN();

  auto param = Config::Str2Map(parameters);
  Config config;
  config.Set(param);
  OMP_SET_NUM_THREADS(config.num_threads);

  std::unique_ptr<Dataset> ret;

  // Prepare the Arrow data
  ArrowTable table(n_chunks, chunks, schema);

  // Initialize the dataset
  if (reference == nullptr) {
    // If there is no reference dataset, we first sample indices
    auto sample_indices = CreateSampleIndices(static_cast<int32_t>(table.get_num_rows()), config);
    auto sample_count = static_cast<int>(sample_indices.size());
    std::vector<std::vector<double>> sample_values(table.get_num_columns());
    std::vector<std::vector<int>> sample_idx(table.get_num_columns());

    // Then, we obtain sample values by parallelizing across columns
    OMP_INIT_EX();
    #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
    for (int64_t j = 0; j < table.get_num_columns(); ++j) {
      OMP_LOOP_EX_BEGIN();

      // Values need to be copied from the record batches.
      sample_values[j].reserve(sample_indices.size());
      sample_idx[j].reserve(sample_indices.size());

      // The chunks are iterated over in the inner loop as columns can be treated independently.
      int last_idx = 0;
      int i = 0;
      auto it = table.get_column(j).begin<double>();
      for (auto idx : sample_indices) {
        std::advance(it, idx - last_idx);
        auto v = *it;
        if (std::fabs(v) > kZeroThreshold || std::isnan(v)) {
          sample_values[j].emplace_back(v);
          sample_idx[j].emplace_back(i);
        }
        last_idx = idx;
        i++;
      }
      OMP_LOOP_EX_END();
    }
    OMP_THROW_EX();

    // Finally, we initialize a loader from the sampled values
    DatasetLoader loader(config, nullptr, 1, nullptr);
    ret.reset(loader.ConstructFromSampleData(Vector2Ptr<double>(&sample_values).data(),
                                             Vector2Ptr<int>(&sample_idx).data(),
                                             table.get_num_columns(),
                                             VectorSize<double>(sample_values).data(),
                                             sample_count,
                                             table.get_num_rows(),
                                             table.get_num_rows()));
  } else {
    ret.reset(new Dataset(static_cast<data_size_t>(table.get_num_rows())));
    ret->CreateValid(reinterpret_cast<const Dataset*>(reference));
    if (ret->has_raw()) {
      ret->ResizeRaw(static_cast<int>(table.get_num_rows()));
    }
  }

  // After sampling and properly initializing all bins, we can add our data to the dataset. Here,
  // we parallelize across rows.
  OMP_INIT_EX();
  #pragma omp parallel for num_threads(OMP_NUM_THREADS()) schedule(static)
  for (int64_t j = 0; j < table.get_num_columns(); ++j) {
    OMP_LOOP_EX_BEGIN();
    const int tid = omp_get_thread_num();
    data_size_t idx = 0;
    auto column = table.get_column(j);
    for (auto it = column.begin<double>(), end = column.end<double>(); it != end; ++it) {
      ret->PushOneValue(tid, idx++, j, *it);
    }
    OMP_LOOP_EX_END();
  }
  OMP_THROW_EX();

  ret->FinishLoad();
  *out = ret.release();
1722
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1723
1724
}

Guolin Ke's avatar
Guolin Ke committed
1725
int LGBM_DatasetGetSubset(
1726
  const DatasetHandle handle,
wxchan's avatar
wxchan committed
1727
1728
1729
  const int32_t* used_row_indices,
  int32_t num_used_row_indices,
  const char* parameters,
Guolin Ke's avatar
typo  
Guolin Ke committed
1730
  DatasetHandle* out) {
wxchan's avatar
wxchan committed
1731
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1732
1733
  auto param = Config::Str2Map(parameters);
  Config config;
1734
  config.Set(param);
1735
  OMP_SET_NUM_THREADS(config.num_threads);
1736
  auto full_dataset = reinterpret_cast<const Dataset*>(handle);
1737
  CHECK_GT(num_used_row_indices, 0);
1738
1739
  const int32_t lower = 0;
  const int32_t upper = full_dataset->num_data() - 1;
1740
  CheckElementsIntervalClosed(used_row_indices, lower, upper, num_used_row_indices, "Used indices of subset");
1741
1742
1743
  if (!std::is_sorted(used_row_indices, used_row_indices + num_used_row_indices)) {
    Log::Fatal("used_row_indices should be sorted in Subset");
  }
Guolin Ke's avatar
Guolin Ke committed
1744
  auto ret = std::unique_ptr<Dataset>(new Dataset(num_used_row_indices));
1745
  ret->CopyFeatureMapperFrom(full_dataset);
1746
  ret->CopySubrow(full_dataset, used_row_indices, num_used_row_indices, true);
wxchan's avatar
wxchan committed
1747
1748
1749
1750
  *out = ret.release();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1751
int LGBM_DatasetSetFeatureNames(
Guolin Ke's avatar
typo  
Guolin Ke committed
1752
  DatasetHandle handle,
Guolin Ke's avatar
Guolin Ke committed
1753
  const char** feature_names,
Guolin Ke's avatar
Guolin Ke committed
1754
  int num_feature_names) {
Guolin Ke's avatar
Guolin Ke committed
1755
1756
1757
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  std::vector<std::string> feature_names_str;
Guolin Ke's avatar
Guolin Ke committed
1758
  for (int i = 0; i < num_feature_names; ++i) {
Guolin Ke's avatar
Guolin Ke committed
1759
1760
1761
1762
1763
1764
    feature_names_str.emplace_back(feature_names[i]);
  }
  dataset->set_feature_names(feature_names_str);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1765
int LGBM_DatasetGetFeatureNames(
1766
1767
1768
1769
1770
1771
    DatasetHandle handle,
    const int len,
    int* num_feature_names,
    const size_t buffer_len,
    size_t* out_buffer_len,
    char** feature_names) {
1772
  API_BEGIN();
1773
  *out_buffer_len = 0;
1774
1775
  auto dataset = reinterpret_cast<Dataset*>(handle);
  auto inside_feature_name = dataset->feature_names();
Guolin Ke's avatar
Guolin Ke committed
1776
1777
  *num_feature_names = static_cast<int>(inside_feature_name.size());
  for (int i = 0; i < *num_feature_names; ++i) {
1778
1779
1780
1781
1782
    if (i < len) {
      std::memcpy(feature_names[i], inside_feature_name[i].c_str(), std::min(inside_feature_name[i].size() + 1, buffer_len));
      feature_names[i][buffer_len - 1] = '\0';
    }
    *out_buffer_len = std::max(inside_feature_name[i].size() + 1, *out_buffer_len);
1783
1784
1785
1786
  }
  API_END();
}

1787
1788
1789
#ifdef _MSC_VER
  #pragma warning(disable : 4702)
#endif
Guolin Ke's avatar
Guolin Ke committed
1790
int LGBM_DatasetFree(DatasetHandle handle) {
1791
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1792
  delete reinterpret_cast<Dataset*>(handle);
1793
  API_END();
1794
1795
}

Guolin Ke's avatar
Guolin Ke committed
1796
int LGBM_DatasetSaveBinary(DatasetHandle handle,
1797
                           const char* filename) {
1798
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1799
1800
  auto dataset = reinterpret_cast<Dataset*>(handle);
  dataset->SaveBinaryFile(filename);
1801
  API_END();
1802
1803
}

1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
int LGBM_DatasetSerializeReferenceToBinary(DatasetHandle handle,
                                           ByteBufferHandle* out,
                                           int32_t* out_len) {
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  std::unique_ptr<LightGBM::ByteBuffer> ret;
  ret.reset(new LightGBM::ByteBuffer());
  dataset->SerializeReference(ret.get());
  *out_len = static_cast<int32_t>(ret->GetSize());
  *out = ret.release();
  API_END();
}

1817
1818
1819
1820
1821
1822
1823
1824
int LGBM_DatasetDumpText(DatasetHandle handle,
                         const char* filename) {
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  dataset->DumpTextFile(filename);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1825
int LGBM_DatasetSetField(DatasetHandle handle,
1826
1827
1828
1829
                         const char* field_name,
                         const void* field_data,
                         int num_element,
                         int type) {
1830
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1831
  auto dataset = reinterpret_cast<Dataset*>(handle);
1832
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
1833
  if (type == C_API_DTYPE_FLOAT32) {
Guolin Ke's avatar
Guolin Ke committed
1834
    is_success = dataset->SetFloatField(field_name, reinterpret_cast<const float*>(field_data), static_cast<int32_t>(num_element));
Guolin Ke's avatar
Guolin Ke committed
1835
  } else if (type == C_API_DTYPE_INT32) {
Guolin Ke's avatar
Guolin Ke committed
1836
    is_success = dataset->SetIntField(field_name, reinterpret_cast<const int*>(field_data), static_cast<int32_t>(num_element));
Guolin Ke's avatar
Guolin Ke committed
1837
1838
  } else if (type == C_API_DTYPE_FLOAT64) {
    is_success = dataset->SetDoubleField(field_name, reinterpret_cast<const double*>(field_data), static_cast<int32_t>(num_element));
1839
  }
1840
  if (!is_success) { Log::Fatal("Input data type error or field not found"); }
1841
  API_END();
1842
1843
}

1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
int LGBM_DatasetSetFieldFromArrow(DatasetHandle handle,
                                  const char* field_name,
                                  int64_t n_chunks,
                                  const ArrowArray* chunks,
                                  const ArrowSchema* schema) {
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
  ArrowChunkedArray ca(n_chunks, chunks, schema);
  auto is_success = dataset->SetFieldFromArrow(field_name, ca);
  if (!is_success) {
    Log::Fatal("Input field is not supported");
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1859
int LGBM_DatasetGetField(DatasetHandle handle,
1860
1861
1862
1863
                         const char* field_name,
                         int* out_len,
                         const void** out_ptr,
                         int* out_type) {
1864
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1865
  auto dataset = reinterpret_cast<Dataset*>(handle);
1866
  bool is_success = false;
Guolin Ke's avatar
Guolin Ke committed
1867
  if (dataset->GetFloatField(field_name, out_len, reinterpret_cast<const float**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
1868
    *out_type = C_API_DTYPE_FLOAT32;
1869
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
1870
  } else if (dataset->GetIntField(field_name, out_len, reinterpret_cast<const int**>(out_ptr))) {
Guolin Ke's avatar
Guolin Ke committed
1871
    *out_type = C_API_DTYPE_INT32;
1872
    is_success = true;
Guolin Ke's avatar
Guolin Ke committed
1873
1874
1875
  } else if (dataset->GetDoubleField(field_name, out_len, reinterpret_cast<const double**>(out_ptr))) {
    *out_type = C_API_DTYPE_FLOAT64;
    is_success = true;
Nikita Titov's avatar
Nikita Titov committed
1876
  }
1877
  if (!is_success) { Log::Fatal("Field not found"); }
wxchan's avatar
wxchan committed
1878
  if (*out_ptr == nullptr) { *out_len = 0; }
1879
  API_END();
1880
1881
}

1882
int LGBM_DatasetUpdateParamChecking(const char* old_parameters, const char* new_parameters) {
1883
  API_BEGIN();
1884
1885
1886
1887
1888
  auto old_param = Config::Str2Map(old_parameters);
  Config old_config;
  old_config.Set(old_param);
  auto new_param = Config::Str2Map(new_parameters);
  Booster::CheckDatasetResetConfig(old_config, new_param);
1889
1890
1891
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
1892
int LGBM_DatasetGetNumData(DatasetHandle handle,
1893
                           int* out) {
1894
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1895
1896
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_data();
1897
  API_END();
1898
1899
}

Guolin Ke's avatar
Guolin Ke committed
1900
int LGBM_DatasetGetNumFeature(DatasetHandle handle,
1901
                              int* out) {
1902
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1903
1904
  auto dataset = reinterpret_cast<Dataset*>(handle);
  *out = dataset->num_total_features();
1905
  API_END();
Guolin Ke's avatar
Guolin Ke committed
1906
}
1907

1908
1909
1910
1911
1912
int LGBM_DatasetGetFeatureNumBin(DatasetHandle handle,
                                 int feature,
                                 int* out) {
  API_BEGIN();
  auto dataset = reinterpret_cast<Dataset*>(handle);
1913
1914
1915
1916
1917
  int num_features = dataset->num_total_features();
  if (feature < 0 || feature >= num_features) {
    Log::Fatal("Tried to retrieve number of bins for feature index %d, "
               "but the valid feature indices are [0, %d].", feature, num_features - 1);
  }
1918
1919
1920
1921
1922
1923
1924
1925
1926
  int inner_idx = dataset->InnerFeatureIndex(feature);
  if (inner_idx >= 0) {
    *out = dataset->FeatureNumBin(inner_idx);
  } else {
    *out = 0;
  }
  API_END();
}

1927
1928
1929
1930
1931
int LGBM_DatasetAddFeaturesFrom(DatasetHandle target,
                                DatasetHandle source) {
  API_BEGIN();
  auto target_d = reinterpret_cast<Dataset*>(target);
  auto source_d = reinterpret_cast<Dataset*>(source);
1932
  target_d->AddFeaturesFrom(source_d);
1933
1934
1935
  API_END();
}

1936
1937
// ---- start of booster

Guolin Ke's avatar
Guolin Ke committed
1938
int LGBM_BoosterCreate(const DatasetHandle train_data,
1939
1940
                       const char* parameters,
                       BoosterHandle* out) {
1941
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1942
  const Dataset* p_train_data = reinterpret_cast<const Dataset*>(train_data);
wxchan's avatar
wxchan committed
1943
1944
  auto ret = std::unique_ptr<Booster>(new Booster(p_train_data, parameters));
  *out = ret.release();
1945
  API_END();
1946
1947
}

Guolin Ke's avatar
Guolin Ke committed
1948
int LGBM_BoosterCreateFromModelfile(
1949
  const char* filename,
Guolin Ke's avatar
Guolin Ke committed
1950
  int* out_num_iterations,
1951
  BoosterHandle* out) {
1952
  API_BEGIN();
wxchan's avatar
wxchan committed
1953
  auto ret = std::unique_ptr<Booster>(new Booster(filename));
Guolin Ke's avatar
Guolin Ke committed
1954
  *out_num_iterations = ret->GetBoosting()->GetCurrentIteration();
wxchan's avatar
wxchan committed
1955
  *out = ret.release();
1956
  API_END();
1957
1958
}

Guolin Ke's avatar
Guolin Ke committed
1959
int LGBM_BoosterLoadModelFromString(
1960
1961
1962
1963
  const char* model_str,
  int* out_num_iterations,
  BoosterHandle* out) {
  API_BEGIN();
wxchan's avatar
wxchan committed
1964
  auto ret = std::unique_ptr<Booster>(new Booster(nullptr));
1965
1966
1967
1968
1969
1970
  ret->LoadModelFromString(model_str);
  *out_num_iterations = ret->GetBoosting()->GetCurrentIteration();
  *out = ret.release();
  API_END();
}

1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
int LGBM_BoosterGetLoadedParam(
  BoosterHandle handle,
  int64_t buffer_len,
  int64_t* out_len,
  char* out_str) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  std::string params = ref_booster->GetBoosting()->GetLoadedParam();
  *out_len = static_cast<int64_t>(params.size()) + 1;
  if (*out_len <= buffer_len) {
    std::memcpy(out_str, params.c_str(), *out_len);
  }
  API_END();
}

1986
1987
1988
#ifdef _MSC_VER
  #pragma warning(disable : 4702)
#endif
Guolin Ke's avatar
Guolin Ke committed
1989
int LGBM_BoosterFree(BoosterHandle handle) {
1990
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
1991
  delete reinterpret_cast<Booster*>(handle);
1992
  API_END();
1993
1994
}

1995
int LGBM_BoosterShuffleModels(BoosterHandle handle, int start_iter, int end_iter) {
1996
1997
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
1998
  ref_booster->ShuffleModels(start_iter, end_iter);
1999
2000
2001
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2002
int LGBM_BoosterMerge(BoosterHandle handle,
2003
                      BoosterHandle other_handle) {
wxchan's avatar
wxchan committed
2004
2005
2006
2007
2008
2009
2010
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  Booster* ref_other_booster = reinterpret_cast<Booster*>(other_handle);
  ref_booster->MergeFrom(ref_other_booster);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2011
int LGBM_BoosterAddValidData(BoosterHandle handle,
2012
                             const DatasetHandle valid_data) {
wxchan's avatar
wxchan committed
2013
2014
2015
2016
2017
2018
2019
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  const Dataset* p_dataset = reinterpret_cast<const Dataset*>(valid_data);
  ref_booster->AddValidData(p_dataset);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2020
int LGBM_BoosterResetTrainingData(BoosterHandle handle,
2021
                                  const DatasetHandle train_data) {
wxchan's avatar
wxchan committed
2022
2023
2024
2025
2026
2027
2028
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  const Dataset* p_dataset = reinterpret_cast<const Dataset*>(train_data);
  ref_booster->ResetTrainingData(p_dataset);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2029
int LGBM_BoosterResetParameter(BoosterHandle handle, const char* parameters) {
wxchan's avatar
wxchan committed
2030
2031
2032
2033
2034
2035
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->ResetConfig(parameters);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2036
int LGBM_BoosterGetNumClasses(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
2037
2038
2039
2040
2041
2042
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetBoosting()->NumberOfClasses();
  API_END();
}

2043
int LGBM_BoosterGetLinear(BoosterHandle handle, int* out) {
2044
2045
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2046
2047
2048
2049
2050
  if (ref_booster->GetBoosting()->IsLinear()) {
    *out = 1;
  } else {
    *out = 0;
  }
2051
2052
2053
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2054
2055
2056
2057
2058
2059
2060
int LGBM_BoosterRefit(BoosterHandle handle, const int32_t* leaf_preds, int32_t nrow, int32_t ncol) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->Refit(leaf_preds, nrow, ncol);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2061
int LGBM_BoosterUpdateOneIter(BoosterHandle handle, int* is_finished) {
2062
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2063
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2064
2065
2066
2067
2068
  if (ref_booster->TrainOneIter()) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
2069
  API_END();
2070
2071
}

Guolin Ke's avatar
Guolin Ke committed
2072
int LGBM_BoosterUpdateOneIterCustom(BoosterHandle handle,
2073
2074
2075
                                    const float* grad,
                                    const float* hess,
                                    int* is_finished) {
2076
  API_BEGIN();
2077
  #ifdef SCORE_T_USE_DOUBLE
2078
2079
2080
2081
  (void) handle;       // UNUSED VARIABLE
  (void) grad;         // UNUSED VARIABLE
  (void) hess;         // UNUSED VARIABLE
  (void) is_finished;  // UNUSED VARIABLE
2082
  Log::Fatal("Don't support custom loss function when SCORE_T_USE_DOUBLE is enabled");
2083
  #else
2084
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2085
2086
2087
2088
2089
  if (ref_booster->TrainOneIter(grad, hess)) {
    *is_finished = 1;
  } else {
    *is_finished = 0;
  }
2090
  #endif
2091
  API_END();
2092
2093
}

Guolin Ke's avatar
Guolin Ke committed
2094
int LGBM_BoosterRollbackOneIter(BoosterHandle handle) {
wxchan's avatar
wxchan committed
2095
2096
2097
2098
2099
2100
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->RollbackOneIter();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2101
int LGBM_BoosterGetCurrentIteration(BoosterHandle handle, int* out_iteration) {
wxchan's avatar
wxchan committed
2102
2103
2104
2105
2106
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_iteration = ref_booster->GetBoosting()->GetCurrentIteration();
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
2107

2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
int LGBM_BoosterNumModelPerIteration(BoosterHandle handle, int* out_tree_per_iteration) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_tree_per_iteration = ref_booster->GetBoosting()->NumModelPerIteration();
  API_END();
}

int LGBM_BoosterNumberOfTotalModel(BoosterHandle handle, int* out_models) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_models = ref_booster->GetBoosting()->NumberOfTotalModel();
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2122
int LGBM_BoosterGetEvalCounts(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
2123
2124
2125
2126
2127
2128
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetEvalCounts();
  API_END();
}

2129
2130
2131
2132
2133
2134
int LGBM_BoosterGetEvalNames(BoosterHandle handle,
                             const int len,
                             int* out_len,
                             const size_t buffer_len,
                             size_t* out_buffer_len,
                             char** out_strs) {
wxchan's avatar
wxchan committed
2135
2136
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2137
  *out_len = ref_booster->GetEvalNames(out_strs, len, buffer_len, out_buffer_len);
wxchan's avatar
wxchan committed
2138
2139
2140
  API_END();
}

2141
2142
2143
2144
2145
2146
int LGBM_BoosterGetFeatureNames(BoosterHandle handle,
                                const int len,
                                int* out_len,
                                const size_t buffer_len,
                                size_t* out_buffer_len,
                                char** out_strs) {
wxchan's avatar
wxchan committed
2147
2148
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2149
  *out_len = ref_booster->GetFeatureNames(out_strs, len, buffer_len, out_buffer_len);
wxchan's avatar
wxchan committed
2150
2151
2152
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2153
int LGBM_BoosterGetNumFeature(BoosterHandle handle, int* out_len) {
wxchan's avatar
wxchan committed
2154
2155
2156
2157
2158
2159
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  *out_len = ref_booster->GetBoosting()->MaxFeatureIdx() + 1;
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2160
int LGBM_BoosterGetEval(BoosterHandle handle,
2161
2162
2163
                        int data_idx,
                        int* out_len,
                        double* out_results) {
2164
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2165
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2166
  auto boosting = ref_booster->GetBoosting();
wxchan's avatar
wxchan committed
2167
  auto result_buf = boosting->GetEvalAt(data_idx);
Guolin Ke's avatar
Guolin Ke committed
2168
  *out_len = static_cast<int>(result_buf.size());
2169
  for (size_t i = 0; i < result_buf.size(); ++i) {
Guolin Ke's avatar
Guolin Ke committed
2170
    (out_results)[i] = static_cast<double>(result_buf[i]);
2171
  }
2172
  API_END();
2173
2174
}

Guolin Ke's avatar
Guolin Ke committed
2175
int LGBM_BoosterGetNumPredict(BoosterHandle handle,
2176
2177
                              int data_idx,
                              int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
2178
2179
2180
2181
2182
2183
  API_BEGIN();
  auto boosting = reinterpret_cast<Booster*>(handle)->GetBoosting();
  *out_len = boosting->GetNumPredictAt(data_idx);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2184
int LGBM_BoosterGetPredict(BoosterHandle handle,
2185
2186
2187
                           int data_idx,
                           int64_t* out_len,
                           double* out_result) {
2188
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2189
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2190
  ref_booster->GetPredictAt(data_idx, out_result, out_len);
2191
  API_END();
Guolin Ke's avatar
Guolin Ke committed
2192
2193
}

Guolin Ke's avatar
Guolin Ke committed
2194
int LGBM_BoosterPredictForFile(BoosterHandle handle,
2195
2196
2197
                               const char* data_filename,
                               int data_has_header,
                               int predict_type,
2198
                               int start_iteration,
2199
                               int num_iteration,
2200
                               const char* parameter,
2201
                               const char* result_filename) {
2202
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2203
2204
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
2205
  config.Set(param);
2206
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
2207
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2208
  ref_booster->Predict(start_iteration, num_iteration, predict_type, data_filename, data_has_header,
Guolin Ke's avatar
Guolin Ke committed
2209
                       config, result_filename);
2210
  API_END();
2211
2212
}

Guolin Ke's avatar
Guolin Ke committed
2213
int LGBM_BoosterCalcNumPredict(BoosterHandle handle,
2214
2215
                               int num_row,
                               int predict_type,
2216
                               int start_iteration,
2217
2218
                               int num_iteration,
                               int64_t* out_len) {
Guolin Ke's avatar
Guolin Ke committed
2219
2220
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2221
  *out_len = static_cast<int64_t>(num_row) * ref_booster->GetBoosting()->NumPredictOneRow(start_iteration,
2222
    num_iteration, predict_type == C_API_PREDICT_LEAF_INDEX, predict_type == C_API_PREDICT_CONTRIB);
Guolin Ke's avatar
Guolin Ke committed
2223
2224
2225
  API_END();
}

2226
2227
2228
2229
2230
2231
// Naming: In future versions of LightGBM, public API named around `FastConfig` should be made named around
// `SingleRowPredictor`, because it is specific to single row prediction, and doesn't actually hold only config.
// For now this is kept as `FastConfig` for backwards compatibility.
// At the same time, one should consider removing the old non-fast single row public API that stores its Predictor
// in the Booster, because that will enable removing these Predictors from the Booster, and associated initialization
// code.
2232
2233
int LGBM_FastConfigFree(FastConfigHandle fastConfig) {
  API_BEGIN();
2234
  delete reinterpret_cast<SingleRowPredictor*>(fastConfig);
2235
2236
2237
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2238
int LGBM_BoosterPredictForCSR(BoosterHandle handle,
2239
2240
2241
2242
2243
2244
2245
                              const void* indptr,
                              int indptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t nindptr,
                              int64_t nelem,
2246
                              int64_t num_col,
2247
                              int predict_type,
2248
                              int start_iteration,
2249
                              int num_iteration,
2250
                              const char* parameter,
2251
2252
                              int64_t* out_len,
                              double* out_result) {
2253
  API_BEGIN();
2254
2255
2256
2257
2258
  if (num_col <= 0) {
    Log::Fatal("The number of columns should be greater than zero.");
  } else if (num_col >= INT32_MAX) {
    Log::Fatal("The number of columns should be smaller than INT32_MAX.");
  }
Guolin Ke's avatar
Guolin Ke committed
2259
2260
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
2261
  config.Set(param);
2262
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
2263
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2264
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
Guolin Ke's avatar
Guolin Ke committed
2265
  int nrow = static_cast<int>(nindptr - 1);
2266
  ref_booster->Predict(start_iteration, num_iteration, predict_type, nrow, static_cast<int>(num_col), get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
2267
                       config, out_result, out_len);
2268
  API_END();
Guolin Ke's avatar
Guolin Ke committed
2269
}
2270

2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
int LGBM_BoosterPredictSparseOutput(BoosterHandle handle,
                                    const void* indptr,
                                    int indptr_type,
                                    const int32_t* indices,
                                    const void* data,
                                    int data_type,
                                    int64_t nindptr,
                                    int64_t nelem,
                                    int64_t num_col_or_row,
                                    int predict_type,
2281
                                    int start_iteration,
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
                                    int num_iteration,
                                    const char* parameter,
                                    int matrix_type,
                                    int64_t* out_len,
                                    void** out_indptr,
                                    int32_t** out_indices,
                                    void** out_data) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
2294
  OMP_SET_NUM_THREADS(config.num_threads);
2295
2296
2297
2298
2299
2300
2301
2302
  if (matrix_type == C_API_MATRIX_TYPE_CSR) {
    if (num_col_or_row <= 0) {
      Log::Fatal("The number of columns should be greater than zero.");
    } else if (num_col_or_row >= INT32_MAX) {
      Log::Fatal("The number of columns should be smaller than INT32_MAX.");
    }
    auto get_row_fun = RowFunctionFromCSR<int64_t>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
    int64_t nrow = nindptr - 1;
2303
    ref_booster->PredictSparseCSR(start_iteration, num_iteration, predict_type, nrow, static_cast<int>(num_col_or_row), get_row_fun,
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
                                  config, out_len, out_indptr, indptr_type, out_indices, out_data, data_type);
  } else if (matrix_type == C_API_MATRIX_TYPE_CSC) {
    int num_threads = OMP_NUM_THREADS();
    int ncol = static_cast<int>(nindptr - 1);
    std::vector<std::vector<CSC_RowIterator>> iterators(num_threads, std::vector<CSC_RowIterator>());
    for (int i = 0; i < num_threads; ++i) {
      for (int j = 0; j < ncol; ++j) {
        iterators[i].emplace_back(indptr, indptr_type, indices, data, data_type, nindptr, nelem, j);
      }
    }
    std::function<std::vector<std::pair<int, double>>(int64_t row_idx)> get_row_fun =
      [&iterators, ncol](int64_t i) {
      std::vector<std::pair<int, double>> one_row;
      one_row.reserve(ncol);
      const int tid = omp_get_thread_num();
      for (int j = 0; j < ncol; ++j) {
        auto val = iterators[tid][j].Get(static_cast<int>(i));
        if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
          one_row.emplace_back(j, val);
        }
      }
      return one_row;
    };
2327
    ref_booster->PredictSparseCSC(start_iteration, num_iteration, predict_type, num_col_or_row, ncol, get_row_fun, config,
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
                                  out_len, out_indptr, indptr_type, out_indices, out_data, data_type);
  } else {
    Log::Fatal("Unknown matrix type in LGBM_BoosterPredictSparseOutput");
  }
  API_END();
}

int LGBM_BoosterFreePredictSparse(void* indptr, int32_t* indices, void* data, int indptr_type, int data_type) {
  API_BEGIN();
  if (indptr_type == C_API_DTYPE_INT32) {
2338
    delete[] reinterpret_cast<int32_t*>(indptr);
2339
  } else if (indptr_type == C_API_DTYPE_INT64) {
2340
    delete[] reinterpret_cast<int64_t*>(indptr);
2341
2342
2343
  } else {
    Log::Fatal("Unknown indptr type in LGBM_BoosterFreePredictSparse");
  }
2344
  delete[] indices;
2345
  if (data_type == C_API_DTYPE_FLOAT32) {
2346
    delete[] reinterpret_cast<float*>(data);
2347
  } else if (data_type == C_API_DTYPE_FLOAT64) {
2348
    delete[] reinterpret_cast<double*>(data);
2349
2350
2351
2352
2353
2354
  } else {
    Log::Fatal("Unknown data type in LGBM_BoosterFreePredictSparse");
  }
  API_END();
}

2355
int LGBM_BoosterPredictForCSRSingleRow(BoosterHandle handle,
2356
2357
2358
2359
2360
2361
2362
                                       const void* indptr,
                                       int indptr_type,
                                       const int32_t* indices,
                                       const void* data,
                                       int data_type,
                                       int64_t nindptr,
                                       int64_t nelem,
2363
                                       int64_t num_col,
2364
                                       int predict_type,
2365
                                       int start_iteration,
2366
2367
2368
2369
                                       int num_iteration,
                                       const char* parameter,
                                       int64_t* out_len,
                                       double* out_result) {
2370
  API_BEGIN();
2371
2372
2373
2374
2375
  if (num_col <= 0) {
    Log::Fatal("The number of columns should be greater than zero.");
  } else if (num_col >= INT32_MAX) {
    Log::Fatal("The number of columns should be smaller than INT32_MAX.");
  }
2376
2377
2378
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
2379
  OMP_SET_NUM_THREADS(config.num_threads);
2380
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2381
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, data_type, nindptr, nelem);
2382
  ref_booster->SetSingleRowPredictorInner(start_iteration, num_iteration, predict_type, config);
2383
  ref_booster->PredictSingleRow(predict_type, static_cast<int32_t>(num_col), get_row_fun, config, out_result, out_len);
2384
2385
2386
  API_END();
}

2387
int LGBM_BoosterPredictForCSRSingleRowFastInit(BoosterHandle handle,
2388
                                               const int predict_type,
2389
                                               const int start_iteration,
2390
                                               const int num_iteration,
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
                                               const int data_type,
                                               const int64_t num_col,
                                               const char* parameter,
                                               FastConfigHandle *out_fastConfig) {
  API_BEGIN();
  if (num_col <= 0) {
    Log::Fatal("The number of columns should be greater than zero.");
  } else if (num_col >= INT32_MAX) {
    Log::Fatal("The number of columns should be smaller than INT32_MAX.");
  }

2402
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2403

2404
2405
  std::unique_ptr<SingleRowPredictor> single_row_predictor =
    ref_booster->InitSingleRowPredictor(start_iteration, num_iteration, predict_type, data_type, static_cast<int32_t>(num_col), parameter);
2406

2407
  OMP_SET_NUM_THREADS(single_row_predictor->config.num_threads);
2408

2409
  *out_fastConfig = single_row_predictor.release();
2410
2411
2412
2413
2414
  API_END();
}

int LGBM_BoosterPredictForCSRSingleRowFast(FastConfigHandle fastConfig_handle,
                                           const void* indptr,
2415
                                           const int indptr_type,
2416
2417
                                           const int32_t* indices,
                                           const void* data,
2418
2419
                                           const int64_t nindptr,
                                           const int64_t nelem,
2420
2421
2422
                                           int64_t* out_len,
                                           double* out_result) {
  API_BEGIN();
2423
2424
2425
  SingleRowPredictor *single_row_predictor = reinterpret_cast<SingleRowPredictor*>(fastConfig_handle);
  auto get_row_fun = RowFunctionFromCSR<int>(indptr, indptr_type, indices, data, single_row_predictor->data_type, nindptr, nelem);
  single_row_predictor->Predict(get_row_fun, out_result, out_len);
2426
2427
2428
  API_END();
}

2429

Guolin Ke's avatar
Guolin Ke committed
2430
int LGBM_BoosterPredictForCSC(BoosterHandle handle,
2431
2432
2433
2434
2435
2436
2437
2438
2439
                              const void* col_ptr,
                              int col_ptr_type,
                              const int32_t* indices,
                              const void* data,
                              int data_type,
                              int64_t ncol_ptr,
                              int64_t nelem,
                              int64_t num_row,
                              int predict_type,
2440
                              int start_iteration,
2441
                              int num_iteration,
2442
                              const char* parameter,
2443
2444
                              int64_t* out_len,
                              double* out_result) {
Guolin Ke's avatar
Guolin Ke committed
2445
2446
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
2447
2448
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
2449
  config.Set(param);
2450
  OMP_SET_NUM_THREADS(config.num_threads);
2451
  int num_threads = OMP_NUM_THREADS();
Guolin Ke's avatar
Guolin Ke committed
2452
  int ncol = static_cast<int>(ncol_ptr - 1);
Guolin Ke's avatar
Guolin Ke committed
2453
2454
2455
2456
2457
  std::vector<std::vector<CSC_RowIterator>> iterators(num_threads, std::vector<CSC_RowIterator>());
  for (int i = 0; i < num_threads; ++i) {
    for (int j = 0; j < ncol; ++j) {
      iterators[i].emplace_back(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem, j);
    }
Guolin Ke's avatar
Guolin Ke committed
2458
2459
  }
  std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun =
Guolin Ke's avatar
Guolin Ke committed
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
      [&iterators, ncol](int i) {
        std::vector<std::pair<int, double>> one_row;
        one_row.reserve(ncol);
        const int tid = omp_get_thread_num();
        for (int j = 0; j < ncol; ++j) {
          auto val = iterators[tid][j].Get(i);
          if (std::fabs(val) > kZeroThreshold || std::isnan(val)) {
            one_row.emplace_back(j, val);
          }
        }
        return one_row;
      };
2472
  ref_booster->Predict(start_iteration, num_iteration, predict_type, static_cast<int>(num_row), ncol, get_row_fun, config,
cbecker's avatar
cbecker committed
2473
                       out_result, out_len);
Guolin Ke's avatar
Guolin Ke committed
2474
2475
2476
  API_END();
}

2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
int LGBM_BoosterValidateFeatureNames(BoosterHandle handle,
                                     const char** data_names,
                                     int data_num_features) {
  API_BEGIN();
  int booster_num_features;
  size_t out_buffer_len;
  LGBM_BoosterGetFeatureNames(handle, 0, &booster_num_features, 0, &out_buffer_len, nullptr);
  if (booster_num_features != data_num_features) {
    Log::Fatal("Model was trained on %d features, but got %d input features to predict.", booster_num_features, data_num_features);
  }
  std::vector<std::vector<char>> tmp_names(booster_num_features, std::vector<char>(out_buffer_len));
  std::vector<char*> booster_names = Vector2Ptr(&tmp_names);
  LGBM_BoosterGetFeatureNames(handle, data_num_features, &booster_num_features, out_buffer_len, &out_buffer_len, booster_names.data());
  for (int i = 0; i < booster_num_features; ++i) {
    if (strcmp(data_names[i], booster_names[i]) != 0) {
      Log::Fatal("Expected '%s' at position %d but found '%s'", booster_names[i], i, data_names[i]);
    }
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2498
int LGBM_BoosterPredictForMat(BoosterHandle handle,
2499
2500
2501
2502
2503
2504
                              const void* data,
                              int data_type,
                              int32_t nrow,
                              int32_t ncol,
                              int is_row_major,
                              int predict_type,
2505
                              int start_iteration,
2506
                              int num_iteration,
2507
                              const char* parameter,
2508
2509
                              int64_t* out_len,
                              double* out_result) {
2510
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2511
2512
  auto param = Config::Str2Map(parameter);
  Config config;
Guolin Ke's avatar
Guolin Ke committed
2513
  config.Set(param);
2514
  OMP_SET_NUM_THREADS(config.num_threads);
Guolin Ke's avatar
Guolin Ke committed
2515
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2516
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, nrow, ncol, data_type, is_row_major);
2517
  ref_booster->Predict(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun,
Guolin Ke's avatar
Guolin Ke committed
2518
                       config, out_result, out_len);
2519
  API_END();
Guolin Ke's avatar
Guolin Ke committed
2520
}
2521

2522
int LGBM_BoosterPredictForMatSingleRow(BoosterHandle handle,
2523
2524
2525
2526
2527
                                       const void* data,
                                       int data_type,
                                       int32_t ncol,
                                       int is_row_major,
                                       int predict_type,
2528
                                       int start_iteration,
2529
2530
2531
2532
                                       int num_iteration,
                                       const char* parameter,
                                       int64_t* out_len,
                                       double* out_result) {
2533
2534
2535
2536
  API_BEGIN();
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
2537
  OMP_SET_NUM_THREADS(config.num_threads);
2538
2539
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, 1, ncol, data_type, is_row_major);
2540
  ref_booster->SetSingleRowPredictorInner(start_iteration, num_iteration, predict_type, config);
2541
  ref_booster->PredictSingleRow(predict_type, ncol, get_row_fun, config, out_result, out_len);
2542
2543
2544
  API_END();
}

2545
int LGBM_BoosterPredictForMatSingleRowFastInit(BoosterHandle handle,
2546
                                               const int predict_type,
2547
                                               const int start_iteration,
2548
                                               const int num_iteration,
2549
2550
2551
2552
2553
                                               const int data_type,
                                               const int32_t ncol,
                                               const char* parameter,
                                               FastConfigHandle *out_fastConfig) {
  API_BEGIN();
2554
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2555

2556
2557
  std::unique_ptr<SingleRowPredictor> single_row_predictor =
    ref_booster->InitSingleRowPredictor(predict_type, start_iteration, num_iteration, data_type, ncol, parameter);
2558

2559
  OMP_SET_NUM_THREADS(single_row_predictor->config.num_threads);
2560

2561
  *out_fastConfig = single_row_predictor.release();
2562
2563
2564
2565
2566
2567
2568
2569
  API_END();
}

int LGBM_BoosterPredictForMatSingleRowFast(FastConfigHandle fastConfig_handle,
                                           const void* data,
                                           int64_t* out_len,
                                           double* out_result) {
  API_BEGIN();
2570
  SingleRowPredictor *single_row_predictor = reinterpret_cast<SingleRowPredictor*>(fastConfig_handle);
2571
  // Single row in row-major format:
2572
2573
  auto get_row_fun = RowPairFunctionFromDenseMatric(data, 1, single_row_predictor->num_cols, single_row_predictor->data_type, 1);
  single_row_predictor->Predict(get_row_fun, out_result, out_len);
2574
2575
2576
  API_END();
}

2577

2578
2579
2580
2581
2582
2583
int LGBM_BoosterPredictForMats(BoosterHandle handle,
                               const void** data,
                               int data_type,
                               int32_t nrow,
                               int32_t ncol,
                               int predict_type,
2584
                               int start_iteration,
2585
2586
2587
2588
2589
2590
2591
2592
                               int num_iteration,
                               const char* parameter,
                               int64_t* out_len,
                               double* out_result) {
  API_BEGIN();
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
2593
  OMP_SET_NUM_THREADS(config.num_threads);
2594
2595
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  auto get_row_fun = RowPairFunctionFromDenseRows(data, ncol, data_type);
2596
  ref_booster->Predict(start_iteration, num_iteration, predict_type, nrow, ncol, get_row_fun, config, out_result, out_len);
2597
2598
2599
  API_END();
}

2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
int LGBM_BoosterPredictForArrow(BoosterHandle handle,
                                int64_t n_chunks,
                                const ArrowArray* chunks,
                                const ArrowSchema* schema,
                                int predict_type,
                                int start_iteration,
                                int num_iteration,
                                const char* parameter,
                                int64_t* out_len,
                                double* out_result) {
  API_BEGIN();

  // Apply the configuration
  auto param = Config::Str2Map(parameter);
  Config config;
  config.Set(param);
  OMP_SET_NUM_THREADS(config.num_threads);

  // Set up chunked array and iterators for all columns
  ArrowTable table(n_chunks, chunks, schema);
  std::vector<ArrowChunkedArray::Iterator<double>> its;
  its.reserve(table.get_num_columns());
  for (int64_t j = 0; j < table.get_num_columns(); ++j) {
    its.emplace_back(table.get_column(j).begin<double>());
  }

  // Build row function
  auto num_columns = table.get_num_columns();
  auto row_fn = [num_columns, &its] (int row_idx) {
    std::vector<std::pair<int, double>> result;
    result.reserve(num_columns);
    for (int64_t j = 0; j < num_columns; ++j) {
      result.emplace_back(static_cast<int>(j), its[j][row_idx]);
    }
    return result;
  };

  // Run prediction
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  ref_booster->Predict(start_iteration,
                       num_iteration,
                       predict_type,
                       static_cast<int>(table.get_num_rows()),
                       static_cast<int>(table.get_num_columns()),
                       row_fn,
                       config,
                       out_result,
                       out_len);
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2651
int LGBM_BoosterSaveModel(BoosterHandle handle,
2652
                          int start_iteration,
2653
                          int num_iteration,
2654
                          int feature_importance_type,
2655
                          const char* filename) {
2656
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2657
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2658
2659
  ref_booster->SaveModelToFile(start_iteration, num_iteration,
                               feature_importance_type, filename);
wxchan's avatar
wxchan committed
2660
2661
2662
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2663
int LGBM_BoosterSaveModelToString(BoosterHandle handle,
2664
                                  int start_iteration,
2665
                                  int num_iteration,
2666
                                  int feature_importance_type,
2667
                                  int64_t buffer_len,
2668
                                  int64_t* out_len,
2669
                                  char* out_str) {
2670
2671
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2672
2673
  std::string model = ref_booster->SaveModelToString(
      start_iteration, num_iteration, feature_importance_type);
2674
  *out_len = static_cast<int64_t>(model.size()) + 1;
2675
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
2676
    std::memcpy(out_str, model.c_str(), *out_len);
2677
2678
2679
2680
  }
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2681
int LGBM_BoosterDumpModel(BoosterHandle handle,
2682
                          int start_iteration,
2683
                          int num_iteration,
2684
                          int feature_importance_type,
2685
2686
                          int64_t buffer_len,
                          int64_t* out_len,
2687
                          char* out_str) {
wxchan's avatar
wxchan committed
2688
2689
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
2690
2691
  std::string model = ref_booster->DumpModel(start_iteration, num_iteration,
                                             feature_importance_type);
2692
  *out_len = static_cast<int64_t>(model.size()) + 1;
wxchan's avatar
wxchan committed
2693
  if (*out_len <= buffer_len) {
Guolin Ke's avatar
Guolin Ke committed
2694
    std::memcpy(out_str, model.c_str(), *out_len);
wxchan's avatar
wxchan committed
2695
  }
2696
  API_END();
Guolin Ke's avatar
Guolin Ke committed
2697
}
2698

Guolin Ke's avatar
Guolin Ke committed
2699
int LGBM_BoosterGetLeafValue(BoosterHandle handle,
2700
2701
2702
                             int tree_idx,
                             int leaf_idx,
                             double* out_val) {
Guolin Ke's avatar
Guolin Ke committed
2703
2704
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
2705
  *out_val = static_cast<double>(ref_booster->GetLeafValue(tree_idx, leaf_idx));
Guolin Ke's avatar
Guolin Ke committed
2706
2707
2708
  API_END();
}

Guolin Ke's avatar
Guolin Ke committed
2709
int LGBM_BoosterSetLeafValue(BoosterHandle handle,
2710
2711
2712
                             int tree_idx,
                             int leaf_idx,
                             double val) {
Guolin Ke's avatar
Guolin Ke committed
2713
2714
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
Guolin Ke's avatar
Guolin Ke committed
2715
  ref_booster->SetLeafValue(tree_idx, leaf_idx, val);
Guolin Ke's avatar
Guolin Ke committed
2716
2717
2718
  API_END();
}

2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
int LGBM_BoosterFeatureImportance(BoosterHandle handle,
                                  int num_iteration,
                                  int importance_type,
                                  double* out_results) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  std::vector<double> feature_importances = ref_booster->FeatureImportance(num_iteration, importance_type);
  for (size_t i = 0; i < feature_importances.size(); ++i) {
    (out_results)[i] = feature_importances[i];
  }
  API_END();
}

2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
int LGBM_BoosterGetUpperBoundValue(BoosterHandle handle,
                                   double* out_results) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  double max_value = ref_booster->UpperBoundValue();
  *out_results = max_value;
  API_END();
}

int LGBM_BoosterGetLowerBoundValue(BoosterHandle handle,
                                   double* out_results) {
  API_BEGIN();
  Booster* ref_booster = reinterpret_cast<Booster*>(handle);
  double min_value = ref_booster->LowerBoundValue();
  *out_results = min_value;
  API_END();
}

2750
2751
2752
2753
2754
int LGBM_NetworkInit(const char* machines,
                     int local_listen_port,
                     int listen_time_out,
                     int num_machines) {
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2755
  Config config;
2756
  config.machines = RemoveQuotationSymbol(std::string(machines));
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
  config.local_listen_port = local_listen_port;
  config.num_machines = num_machines;
  config.time_out = listen_time_out;
  if (num_machines > 1) {
    Network::Init(config);
  }
  API_END();
}

int LGBM_NetworkFree() {
  API_BEGIN();
  Network::Dispose();
  API_END();
}

2772
2773
2774
int LGBM_NetworkInitWithFunctions(int num_machines, int rank,
                                  void* reduce_scatter_ext_fun,
                                  void* allgather_ext_fun) {
ww's avatar
ww committed
2775
  API_BEGIN();
Guolin Ke's avatar
Guolin Ke committed
2776
  if (num_machines > 1) {
2777
    Network::Init(num_machines, rank, (ReduceScatterFunction)reduce_scatter_ext_fun, (AllgatherFunction)allgather_ext_fun);
ww's avatar
ww committed
2778
2779
2780
  }
  API_END();
}
Guolin Ke's avatar
Guolin Ke committed
2781

2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
int LGBM_SetMaxThreads(int num_threads) {
  API_BEGIN();
  if (num_threads <= 0) {
    LGBM_MAX_NUM_THREADS = -1;
  } else {
    LGBM_MAX_NUM_THREADS = num_threads;
  }
  API_END();
}

int LGBM_GetMaxThreads(int* out) {
  API_BEGIN();
  *out = LGBM_MAX_NUM_THREADS;
  API_END();
}


Guolin Ke's avatar
Guolin Ke committed
2799
// ---- start of some help functions
2800

2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825

template<typename T>
std::function<std::vector<double>(int row_idx)>
RowFunctionFromDenseMatric_helper(const void* data, int num_row, int num_col, int is_row_major) {
  const T* data_ptr = reinterpret_cast<const T*>(data);
  if (is_row_major) {
    return [=] (int row_idx) {
      std::vector<double> ret(num_col);
      auto tmp_ptr = data_ptr + static_cast<size_t>(num_col) * row_idx;
      for (int i = 0; i < num_col; ++i) {
        ret[i] = static_cast<double>(*(tmp_ptr + i));
      }
      return ret;
    };
  } else {
    return [=] (int row_idx) {
      std::vector<double> ret(num_col);
      for (int i = 0; i < num_col; ++i) {
        ret[i] = static_cast<double>(*(data_ptr + static_cast<size_t>(num_row) * i + row_idx));
      }
      return ret;
    };
  }
}

2826
2827
std::function<std::vector<double>(int row_idx)>
RowFunctionFromDenseMatric(const void* data, int num_row, int num_col, int data_type, int is_row_major) {
Guolin Ke's avatar
Guolin Ke committed
2828
  if (data_type == C_API_DTYPE_FLOAT32) {
2829
    return RowFunctionFromDenseMatric_helper<float>(data, num_row, num_col, is_row_major);
Guolin Ke's avatar
Guolin Ke committed
2830
  } else if (data_type == C_API_DTYPE_FLOAT64) {
2831
    return RowFunctionFromDenseMatric_helper<double>(data, num_row, num_col, is_row_major);
2832
  }
2833
  Log::Fatal("Unknown data type in RowFunctionFromDenseMatric");
2834
  return nullptr;
2835
2836
2837
2838
}

std::function<std::vector<std::pair<int, double>>(int row_idx)>
RowPairFunctionFromDenseMatric(const void* data, int num_row, int num_col, int data_type, int is_row_major) {
Guolin Ke's avatar
Guolin Ke committed
2839
2840
  auto inner_function = RowFunctionFromDenseMatric(data, num_row, num_col, data_type, is_row_major);
  if (inner_function != nullptr) {
2841
    return [inner_function] (int row_idx) {
Guolin Ke's avatar
Guolin Ke committed
2842
2843
      auto raw_values = inner_function(row_idx);
      std::vector<std::pair<int, double>> ret;
Guolin Ke's avatar
Guolin Ke committed
2844
      ret.reserve(raw_values.size());
Guolin Ke's avatar
Guolin Ke committed
2845
      for (int i = 0; i < static_cast<int>(raw_values.size()); ++i) {
Guolin Ke's avatar
Guolin Ke committed
2846
        if (std::fabs(raw_values[i]) > kZeroThreshold || std::isnan(raw_values[i])) {
Guolin Ke's avatar
Guolin Ke committed
2847
          ret.emplace_back(i, raw_values[i]);
2848
        }
Guolin Ke's avatar
Guolin Ke committed
2849
2850
2851
      }
      return ret;
    };
2852
  }
Guolin Ke's avatar
Guolin Ke committed
2853
  return nullptr;
2854
2855
}

2856
2857
2858
2859
2860
2861
2862
// data is array of pointers to individual rows
std::function<std::vector<std::pair<int, double>>(int row_idx)>
RowPairFunctionFromDenseRows(const void** data, int num_col, int data_type) {
  return [=](int row_idx) {
    auto inner_function = RowFunctionFromDenseMatric(data[row_idx], 1, num_col, data_type, /* is_row_major */ true);
    auto raw_values = inner_function(0);
    std::vector<std::pair<int, double>> ret;
Guolin Ke's avatar
Guolin Ke committed
2863
    ret.reserve(raw_values.size());
2864
2865
2866
2867
2868
2869
2870
2871
2872
    for (int i = 0; i < static_cast<int>(raw_values.size()); ++i) {
      if (std::fabs(raw_values[i]) > kZeroThreshold || std::isnan(raw_values[i])) {
        ret.emplace_back(i, raw_values[i]);
      }
    }
    return ret;
  };
}

2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
template<typename T, typename T1, typename T2>
std::function<std::vector<std::pair<int, double>>(T idx)>
RowFunctionFromCSR_helper(const void* indptr, const int32_t* indices, const void* data) {
  const T1* data_ptr = reinterpret_cast<const T1*>(data);
  const T2* ptr_indptr = reinterpret_cast<const T2*>(indptr);
  return [=] (T idx) {
    std::vector<std::pair<int, double>> ret;
    int64_t start = ptr_indptr[idx];
    int64_t end = ptr_indptr[idx + 1];
    if (end - start > 0)  {
      ret.reserve(end - start);
    }
    for (int64_t i = start; i < end; ++i) {
      ret.emplace_back(indices[i], data_ptr[i]);
    }
    return ret;
  };
}

2892
2893
template<typename T>
std::function<std::vector<std::pair<int, double>>(T idx)>
2894
RowFunctionFromCSR(const void* indptr, int indptr_type, const int32_t* indices, const void* data, int data_type, int64_t , int64_t ) {
Guolin Ke's avatar
Guolin Ke committed
2895
2896
  if (data_type == C_API_DTYPE_FLOAT32) {
    if (indptr_type == C_API_DTYPE_INT32) {
2897
     return RowFunctionFromCSR_helper<T, float, int32_t>(indptr, indices, data);
Guolin Ke's avatar
Guolin Ke committed
2898
    } else if (indptr_type == C_API_DTYPE_INT64) {
2899
     return RowFunctionFromCSR_helper<T, float, int64_t>(indptr, indices, data);
2900
    }
Guolin Ke's avatar
Guolin Ke committed
2901
2902
  } else if (data_type == C_API_DTYPE_FLOAT64) {
    if (indptr_type == C_API_DTYPE_INT32) {
2903
     return RowFunctionFromCSR_helper<T, double, int32_t>(indptr, indices, data);
Guolin Ke's avatar
Guolin Ke committed
2904
    } else if (indptr_type == C_API_DTYPE_INT64) {
2905
     return RowFunctionFromCSR_helper<T, double, int64_t>(indptr, indices, data);
Guolin Ke's avatar
Guolin Ke committed
2906
2907
    }
  }
2908
  Log::Fatal("Unknown data type in RowFunctionFromCSR");
2909
  return nullptr;
2910
2911
}

2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930


template <typename T1, typename T2>
std::function<std::pair<int, double>(int idx)> IterateFunctionFromCSC_helper(const void* col_ptr, const int32_t* indices, const void* data, int col_idx) {
  const T1* data_ptr = reinterpret_cast<const T1*>(data);
  const T2* ptr_col_ptr = reinterpret_cast<const T2*>(col_ptr);
  int64_t start = ptr_col_ptr[col_idx];
  int64_t end = ptr_col_ptr[col_idx + 1];
  return [=] (int offset) {
    int64_t i = static_cast<int64_t>(start + offset);
    if (i >= end) {
      return std::make_pair(-1, 0.0);
    }
    int idx = static_cast<int>(indices[i]);
    double val = static_cast<double>(data_ptr[i]);
    return std::make_pair(idx, val);
  };
}

Guolin Ke's avatar
Guolin Ke committed
2931
std::function<std::pair<int, double>(int idx)>
2932
IterateFunctionFromCSC(const void* col_ptr, int col_ptr_type, const int32_t* indices, const void* data, int data_type, int64_t ncol_ptr, int64_t , int col_idx) {
Guolin Ke's avatar
Guolin Ke committed
2933
  CHECK(col_idx < ncol_ptr && col_idx >= 0);
Guolin Ke's avatar
Guolin Ke committed
2934
2935
  if (data_type == C_API_DTYPE_FLOAT32) {
    if (col_ptr_type == C_API_DTYPE_INT32) {
2936
      return IterateFunctionFromCSC_helper<float, int32_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2937
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
2938
      return IterateFunctionFromCSC_helper<float, int64_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2939
    }
Guolin Ke's avatar
Guolin Ke committed
2940
2941
  } else if (data_type == C_API_DTYPE_FLOAT64) {
    if (col_ptr_type == C_API_DTYPE_INT32) {
2942
      return IterateFunctionFromCSC_helper<double, int32_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2943
    } else if (col_ptr_type == C_API_DTYPE_INT64) {
2944
      return IterateFunctionFromCSC_helper<double, int64_t>(col_ptr, indices, data, col_idx);
Guolin Ke's avatar
Guolin Ke committed
2945
2946
    }
  }
2947
  Log::Fatal("Unknown data type in CSC matrix");
2948
  return nullptr;
2949
2950
}

Guolin Ke's avatar
Guolin Ke committed
2951
CSC_RowIterator::CSC_RowIterator(const void* col_ptr, int col_ptr_type, const int32_t* indices,
2952
                                 const void* data, int data_type, int64_t ncol_ptr, int64_t nelem, int col_idx) {
Guolin Ke's avatar
Guolin Ke committed
2953
2954
2955
2956
2957
2958
2959
2960
2961
  iter_fun_ = IterateFunctionFromCSC(col_ptr, col_ptr_type, indices, data, data_type, ncol_ptr, nelem, col_idx);
}

double CSC_RowIterator::Get(int idx) {
  while (idx > cur_idx_ && !is_end_) {
    auto ret = iter_fun_(nonzero_idx_);
    if (ret.first < 0) {
      is_end_ = true;
      break;
2962
    }
Guolin Ke's avatar
Guolin Ke committed
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
    cur_idx_ = ret.first;
    cur_val_ = ret.second;
    ++nonzero_idx_;
  }
  if (idx == cur_idx_) {
    return cur_val_;
  } else {
    return 0.0f;
  }
}

std::pair<int, double> CSC_RowIterator::NextNonZero() {
  if (!is_end_) {
    auto ret = iter_fun_(nonzero_idx_);
    ++nonzero_idx_;
    if (ret.first < 0) {
      is_end_ = true;
2980
    }
Guolin Ke's avatar
Guolin Ke committed
2981
2982
2983
    return ret;
  } else {
    return std::make_pair(-1, 0.0);
2984
  }
Guolin Ke's avatar
Guolin Ke committed
2985
}