Uniform header inclusion and clang-format tooling (#1343)

Author: AntoinePrv

.clang-format

@@ -4,5 +4,24 @@ AlignAfterOpenBracket: Align
 AlignConsecutiveDeclarations: 'false'
 BreakBeforeBraces: Allman
 NamespaceIndentation: All
+IncludeBlocks: Regroup
+# First regex to match classifies the header into a group.
+# Group are ordered in the source code by increasing priority.
+IncludeCategories:
+  # Standard headers
+  - Regex: <[^\.]+>
+    Priority: 4
+  # Third party dependencies (prefer angle bracket over quotes)
+  - Regex: <.+\..+>
+    Priority: 3
+  # xsimd absolute headers (e.g. in tests)
+  - Regex: '["<]xsimd/.+[">]'
+    Priority: 2
+  # Relative header from project
+  - Regex: '"\.+.*"'
+    Priority: 1
+  # Not quoted header (anything else, avoid)
+  - Regex: '".*"'
+    Priority: 0
 
 ...

benchmark/main.cpp

@@ -9,12 +9,12 @@
  * The full license is in the file LICENSE, distributed with this software. *
  ****************************************************************************/
 
+#include "xsimd_benchmark.hpp"
+
 #include <iostream>
 #include <map>
 #include <string>
 
-#include "xsimd_benchmark.hpp"
-
 void benchmark_operation()
 {
     // std::size_t size = 9984;

benchmark/xsimd_benchmark.hpp

@@ -14,6 +14,7 @@
 
 #include "xsimd/arch/xsimd_scalar.hpp"
 #include "xsimd/xsimd.hpp"
+
 #include <chrono>
 #include <string>
 #include <vector>

examples/mandelbrot.cpp

@@ -13,15 +13,15 @@
 // https://github.com/ospray/tsimd/blob/master/benchmarks/mandelbrot.cpp
 // Author Jefferson Amstutz / intel
 
+#include "pico_bench.hpp"
+
+#include <xsimd/xsimd.hpp>
+
 #include <cstdio>
 #include <iostream>
 #include <string>
 #include <vector>
 
-#include "pico_bench.hpp"
-
-#include <xsimd/xsimd.hpp>
-
 // helper function to write the rendered image as PPM file
 inline void writePPM(const std::string& fileName,
                      const int sizeX,

include/xsimd/arch/common/xsimd_common_arithmetic.hpp

@@ -12,13 +12,13 @@
 #ifndef XSIMD_COMMON_ARITHMETIC_HPP
 #define XSIMD_COMMON_ARITHMETIC_HPP
 
+#include "../../types/xsimd_batch_constant.hpp"
+#include "./xsimd_common_details.hpp"
+
 #include <complex>
 #include <limits>
 #include <type_traits>
 
-#include "../../types/xsimd_batch_constant.hpp"
-#include "./xsimd_common_details.hpp"
-
 namespace xsimd
 {
 

include/xsimd/arch/common/xsimd_common_cast.hpp

@@ -12,11 +12,11 @@
 #ifndef XSIMD_COMMON_CAST_HPP
 #define XSIMD_COMMON_CAST_HPP
 
-#include <array>
-
 #include "../../config/xsimd_macros.hpp"
 #include "../../utils/xsimd_type_traits.hpp"
 
+#include <array>
+
 namespace xsimd
 {
     namespace kernel

include/xsimd/arch/common/xsimd_common_complex.hpp

@@ -12,10 +12,10 @@
 #ifndef XSIMD_COMMON_COMPLEX_HPP
 #define XSIMD_COMMON_COMPLEX_HPP
 
-#include <complex>
-
 #include "./xsimd_common_details.hpp"
 
+#include <complex>
+
 namespace xsimd
 {
 

include/xsimd/arch/common/xsimd_common_details.hpp

@@ -12,13 +12,13 @@
 #ifndef XSIMD_COMMON_DETAILS_HPP
 #define XSIMD_COMMON_DETAILS_HPP
 
-#include <complex>
-
 #include "../../math/xsimd_rem_pio2.hpp"
 #include "../../types/xsimd_common_arch.hpp"
 #include "../../types/xsimd_utils.hpp"
 #include "../xsimd_constants.hpp"
 
+#include <complex>
+
 namespace xsimd
 {
     // Forward declaration. Should we put them in a separate file?

include/xsimd/arch/common/xsimd_common_memory.hpp

@@ -12,13 +12,13 @@
 #ifndef XSIMD_COMMON_MEMORY_HPP
 #define XSIMD_COMMON_MEMORY_HPP
 
+#include "../../types/xsimd_batch_constant.hpp"
+#include "./xsimd_common_details.hpp"
+
 #include <algorithm>
 #include <array>
 #include <complex>
 
-#include "../../types/xsimd_batch_constant.hpp"
-#include "./xsimd_common_details.hpp"
-
 namespace xsimd
 {
     template <typename T, class A, T... Values>

include/xsimd/arch/common/xsimd_common_swizzle.hpp

@@ -12,12 +12,12 @@
 #ifndef XSIMD_COMMON_SWIZZLE_HPP
 #define XSIMD_COMMON_SWIZZLE_HPP
 
+#include "../../config/xsimd_macros.hpp"
+
 #include <cstddef>
 #include <cstdint>
 #include <type_traits>
 
-#include "../../config/xsimd_macros.hpp"
-
 namespace xsimd
 {
     template <typename T, class A, T... Values>