Code syle cleanup

microsoft · Apr 11, 2020 · ce384e9 · ce384e9
1 parent 868c5fb
commit ce384e9
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 31 deletions.
diff --git a/include/LightGBM/c_api.h b/include/LightGBM/c_api.h
@@ -886,7 +886,7 @@ LIGHTGBM_C_EXPORT int LGBM_BoosterPredictForMatSingleRow(BoosterHandle handle,
 /*!
  * \brief Release FastConfig object.
  *
- * \param fastConfig Handle to the FastConfig object acquired with a `...FastInit()` method.
+ * \param fastConfig Handle to the FastConfig object acquired with a `*FastInit()` method.
  * \return LIGHTGBM_C_EXPORT LGBM_FastConfigFree
  */
 LIGHTGBM_C_EXPORT int LGBM_FastConfigFree(FastConfigHandle fastConfig);

diff --git a/src/c_api.cpp b/src/c_api.cpp
@@ -1645,23 +1645,15 @@ int LGBM_BoosterPredictForMatSingleRow(BoosterHandle handle,
   API_END();
 }
 
-/*
-struct SingleRowPredictCfg {
-  Config config;
-  Booster* ref_booster;
-  int is_row_major;
-  int predict_type;
-  int num_iteration;
-  std::function<std::vector<std::pair<int, double>>(int row_idx)> get_row_fun;
-}
-*/
-
-
-static Config _PredictForMatSingleRowFastConfig_;
-static std::function<std::vector<std::pair<int, double>>(int row_idx)> _get_row_fun_fast_;
-
 /*!
- * \brief Store resources meant for single-row Fast Predict methods.
+ * \brief Object to store resources meant for single-row Fast Predict methods.
+ *
+ * Meant to be used as a basic struct by the *Fast* predict methods only.
+ * It stores the configuration resources for reuse during prediction.
+ *
+ * Even the row function is stored. We score the instance at the same memory
+ * address all the time. One just replaces the feature values at that address
+ * and scores again with the *Fast* methods.
  */
 struct FastConfig {
  public:
@@ -1673,17 +1665,17 @@ struct FastConfig {
   }
 
   friend int LGBM_BoosterPredictForMatSingleRowFastInit(BoosterHandle handle,
-                                               const void* data,
-                                               int data_type,
-                                               int32_t ncol,
-                                               const char* parameter,
-                                               FastConfigHandle *out_fastConfig);
+                                                        const void* data,
+                                                        int data_type,
+                                                        int32_t ncol,
+                                                        const char* parameter,
+                                                        FastConfigHandle *out_fastConfig);
 
   friend int LGBM_BoosterPredictForMatSingleRowFast(FastConfigHandle fast_config_handle,
-                                           int predict_type,
-                                           int num_iteration,
-                                           int64_t* out_len,
-                                           double* out_result);
+                                                    int predict_type,
+                                                    int num_iteration,
+                                                    int64_t* out_len,
+                                                    double* out_result);
  private:
   Booster* booster;
   Config config;
@@ -1704,18 +1696,18 @@ int LGBM_BoosterPredictForMatSingleRowFastInit(BoosterHandle handle,
                                                const char* parameter,
                                                FastConfigHandle *out_fastConfig) {
   API_BEGIN();
-  auto fastPredictConfig_ptr = std::unique_ptr<FastConfig>(new FastConfig(
+  auto fastConfig_ptr = std::unique_ptr<FastConfig>(new FastConfig(
     reinterpret_cast<Booster*>(handle),
     parameter,
-    RowPairFunctionFromDenseMatric(data, 1, ncol, data_type, 1),
+    RowPairFunctionFromDenseMatric(data, 1, ncol, data_type, 1), // Single row in row-major format.
     ncol
   ));
 
-  if (fastPredictConfig_ptr->config.num_threads > 0) {
-    omp_set_num_threads(fastPredictConfig_ptr->config.num_threads);
+  if (fastConfig_ptr->config.num_threads > 0) {
+    omp_set_num_threads(fastConfig_ptr->config.num_threads);
   }
 
-  *out_fastConfig = fastPredictConfig_ptr.release();
+  *out_fastConfig = fastConfig_ptr.release();
   API_END();
 }