add notes for ArgMaxAtK and MaxK

microsoft · Jan 15, 2018 · d90369a · d90369a
1 parent 0f0eb69
commit d90369a
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/include/LightGBM/utils/array_args.h b/include/LightGBM/utils/array_args.h
@@ -126,7 +126,7 @@ class ArrayArgs {
     *r = i;
   };
 
-  // Note: k refer to index here. e.g. k=0 means get max number.
+  // Note: k refer to index here. e.g. k=0 means get the max number.
   inline static int ArgMaxAtK(std::vector<VAL_T>* arr, int start, int end, int k) {
     if (start >= end - 1) {
       return start;
@@ -144,6 +144,7 @@ class ArrayArgs {
     }
   }
 
+  // Note: k is 1-based here. e.g. k=3 means get the top-3 numbers.
   inline static void MaxK(const std::vector<VAL_T>& array, int k, std::vector<VAL_T>* out) {
     out->clear();
     if (k <= 0) {