Automate C++ include file grouping and ordering using clang-format

cpp/.clang-format

@@ -15,7 +15,7 @@ AlignTrailingComments: true
 AllowAllArgumentsOnNextLine: true
 AllowAllConstructorInitializersOnNextLine: true
 AllowAllParametersOfDeclarationOnNextLine: true
-AllowShortBlocksOnASingleLine: true 
+AllowShortBlocksOnASingleLine: true
 AllowShortCaseLabelsOnASingleLine: true
 AllowShortEnumsOnASingleLine: true
 AllowShortFunctionsOnASingleLine: All
@@ -27,7 +27,7 @@ AlwaysBreakAfterDefinitionReturnType: None
 AlwaysBreakAfterReturnType: None
 AlwaysBreakBeforeMultilineStrings: true
 AlwaysBreakTemplateDeclarations: Yes
-BinPackArguments:  false       
+BinPackArguments:  false
 BinPackParameters: false
 BraceWrapping:
   AfterClass:            false
@@ -71,8 +71,26 @@ ForEachMacros:
   - foreach
   - Q_FOREACH
   - BOOST_FOREACH
-IncludeBlocks: Preserve
-IncludeIsMainRegex: '([-_](test|unittest))?$'
+IncludeBlocks: Regroup
+IncludeCategories:
+  - Regex:           '^"' # quoted includes
+    Priority:        1
+  - Regex:           '^<(common|benchmarks|tests)/' # benchmark/test includes
+    Priority:        2
+  - Regex:           '^<cuml/' # cuML includes
+    Priority:        3
+  - Regex:           '^<(cudf|raft|kvikio|cumlprims)' # Other RAPIDS includes
+    Priority:        4
+  - Regex:           '^<rmm/' # RMM includes
+    Priority:        5
+  - Regex:           '^<(thrust|cub|cuda)/' # CCCL includes
+    Priority:        6
+  - Regex:           '^<(cooperative_groups|cuco|cuda|device_types|driver_types|math_constants|nvtx3)' # CUDA includes
+    Priority:        6
+  - Regex:           '^<.*\..*' # other system includes (e.g. with a '.')
+    Priority:        7
+  - Regex:           '^<[^.]+' # STL includes (no '.')
+    Priority:        8
 IndentCaseLabels: true
 IndentPPDirectives: None
 IndentWidth:     2

cpp/bench/common/ml_benchmark.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2022, NVIDIA CORPORATION.
+ * Copyright (c) 2019-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,13 +16,18 @@
 
 #pragma once
 
-#include <benchmark/benchmark.h>
-#include <cuda_runtime.h>
 #include <cuml/common/logger.hpp>
 #include <cuml/common/utils.hpp>
-#include <memory>
+
 #include <raft/util/cudart_utils.hpp>
+
 #include <rmm/mr/device/per_device_resource.hpp>
+
+#include <cuda_runtime.h>
+
+#include <benchmark/benchmark.h>
+
+#include <memory>
 #include <sstream>
 #include <string>
 #include <vector>

cpp/bench/sg/arima_loglikelihood.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2022, NVIDIA CORPORATION.
+ * Copyright (c) 2020-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,18 +14,20 @@
  * limitations under the License.
  */
 
-#include <thrust/execution_policy.h>
-#include <thrust/for_each.h>
-#include <thrust/iterator/counting_iterator.h>
+#include "benchmark.cuh"
 
 #include <cuml/tsa/arima_common.h>
 #include <cuml/tsa/batched_arima.hpp>
+
 #include <raft/core/handle.hpp>
 #include <raft/random/rng.cuh>
+#include <raft/util/cudart_utils.hpp>
+
 #include <rmm/device_uvector.hpp>
 
-#include "benchmark.cuh"
-#include <raft/util/cudart_utils.hpp>
+#include <thrust/execution_policy.h>
+#include <thrust/for_each.h>
+#include <thrust/iterator/counting_iterator.h>
 
 namespace ML {
 namespace Bench {

cpp/bench/sg/benchmark.cuh

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2022, NVIDIA CORPORATION.
+ * Copyright (c) 2019-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,12 +19,16 @@
 #include "../common/ml_benchmark.hpp"
 #include "dataset.cuh"
 #include "dataset_ts.cuh"
-#include <benchmark/benchmark.h>
-#include <cuda_runtime.h>
+
 #include <cuml/common/logger.hpp>
+
 #include <raft/core/handle.hpp>
 #include <raft/util/cudart_utils.hpp>
 
+#include <cuda_runtime.h>
+
+#include <benchmark/benchmark.h>
+
 namespace ML {
 namespace Bench {
 

cpp/bench/sg/dataset.cuh

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2023, NVIDIA CORPORATION.
+ * Copyright (c) 2019-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,14 +17,16 @@
 #pragma once
 
 #include <cuml/datasets/make_blobs.hpp>
-#include <fstream>
-#include <iostream>
+
 #include <raft/core/handle.hpp>
 #include <raft/linalg/transpose.cuh>
 #include <raft/linalg/unary_op.cuh>
 #include <raft/random/make_regression.cuh>
 #include <raft/util/cuda_utils.cuh>
 #include <raft/util/cudart_utils.hpp>
+
+#include <fstream>
+#include <iostream>
 #include <sstream>
 #include <string>
 #include <vector>

cpp/bench/sg/dbscan.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2023, NVIDIA CORPORATION.
+ * Copyright (c) 2019-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 
+#include "benchmark.cuh"
+
 #include <cuml/cluster/dbscan.hpp>
 
-#include "benchmark.cuh"
 #include <utility>
 
 namespace ML {

cpp/bench/sg/fil.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2023, NVIDIA CORPORATION.
+ * Copyright (c) 2019-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,14 +14,16 @@
  * limitations under the License.
  */
 
-#include <cuml/fil/fil.h>
-
 #include "benchmark.cuh"
+
 #include <cuml/common/logger.hpp>
 #include <cuml/ensemble/randomforest.hpp>
+#include <cuml/fil/fil.h>
 #include <cuml/tree/algo_helper.h>
+
 #include <treelite/c_api.h>
 #include <treelite/tree.h>
+
 #include <utility>
 
 namespace ML {

cpp/bench/sg/filex.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, NVIDIA CORPORATION.
+ * Copyright (c) 2023-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,20 +14,22 @@
  * limitations under the License.
  */
 
+#include "benchmark.cuh"
+
+#include <cuml/common/logger.hpp>
+#include <cuml/ensemble/randomforest.hpp>
 #include <cuml/experimental/fil/detail/raft_proto/device_type.hpp>
 #include <cuml/experimental/fil/infer_kind.hpp>
 #include <cuml/experimental/fil/tree_layout.hpp>
 #include <cuml/experimental/fil/treelite_importer.hpp>
 #include <cuml/fil/fil.h>
-
-#include "benchmark.cuh"
-#include <chrono>
-#include <cstdint>
-#include <cuml/common/logger.hpp>
-#include <cuml/ensemble/randomforest.hpp>
 #include <cuml/tree/algo_helper.h>
+
 #include <treelite/c_api.h>
 #include <treelite/tree.h>
+
+#include <chrono>
+#include <cstdint>
 #include <utility>
 
 namespace ML {

cpp/bench/sg/kmeans.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2023, NVIDIA CORPORATION.
+ * Copyright (c) 2019-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,10 +15,13 @@
  */
 
 #include "benchmark.cuh"
+
 #include <cuml/cluster/kmeans.hpp>
 #include <cuml/common/logger.hpp>
+
 #include <raft/distance/distance_types.hpp>
 #include <raft/random/rng_state.hpp>
+
 #include <utility>
 
 namespace ML {

cpp/bench/sg/linkage.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2022, NVIDIA CORPORATION.
+ * Copyright (c) 2019-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,10 +15,13 @@
  */
 
 #include "benchmark.cuh"
+
 #include <cuml/cluster/linkage.hpp>
 #include <cuml/common/logger.hpp>
+
 #include <raft/distance/distance_types.hpp>
 #include <raft/sparse/hierarchy/common.h>
+
 #include <utility>
 
 namespace ML {

cpp/bench/sg/rf_classifier.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2023, NVIDIA CORPORATION.
+ * Copyright (c) 2019-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,10 @@
  */
 
 #include "benchmark.cuh"
-#include <cmath>
+
 #include <cuml/ensemble/randomforest.hpp>
+
+#include <cmath>
 #include <utility>
 
 namespace ML {

cpp/bench/sg/rf_regressor.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019-2023, NVIDIA CORPORATION.
+ * Copyright (c) 2019-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,10 @@
  */
 
 #include "benchmark.cuh"
-#include <cmath>
+
 #include <cuml/ensemble/randomforest.hpp>
+
+#include <cmath>
 #include <utility>
 
 namespace ML {

cpp/bench/sg/svc.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2023, NVIDIA CORPORATION.
+ * Copyright (c) 2020-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,11 +15,14 @@
  */
 
 #include "benchmark.cuh"
-#include <cmath>
+
 #include <cuml/svm/svc.hpp>
 #include <cuml/svm/svm_model.h>
 #include <cuml/svm/svm_parameter.h>
+
 #include <raft/distance/kernels.cuh>
+
+#include <cmath>
 #include <sstream>
 #include <utility>
 

cpp/bench/sg/svr.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2023, NVIDIA CORPORATION.
+ * Copyright (c) 2020-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,12 +15,15 @@
  */
 
 #include "benchmark.cuh"
-#include <cmath>
+
 #include <cuml/svm/svc.hpp>
 #include <cuml/svm/svm_model.h>
 #include <cuml/svm/svm_parameter.h>
 #include <cuml/svm/svr.hpp>
+
 #include <raft/distance/kernels.cuh>
+
+#include <cmath>
 #include <utility>
 
 namespace ML {

cpp/bench/sg/umap.cu

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2022, NVIDIA CORPORATION.
+ * Copyright (c) 2020-2024, NVIDIA CORPORATION.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,9 +15,12 @@
  */
 
 #include "benchmark.cuh"
+
 #include <cuml/manifold/umap.hpp>
 #include <cuml/manifold/umapparams.h>
+
 #include <raft/util/cuda_utils.cuh>
+
 #include <utility>
 
 namespace ML {