Merge pull request #629 from xtensor-stack/feature/clang-format

Feature/clang format

Author: serge-sans-paille

.clang-format

@@ -0,0 +1,8 @@
+---
+BasedOnStyle: WebKit
+AlignAfterOpenBracket: Align
+AlignConsecutiveDeclarations: 'false'
+BreakBeforeBraces: Allman
+NamespaceIndentation: All
+
+...

.github/workflows/clang-format-check.yml

@@ -0,0 +1,12 @@
+name: clang-format
+on: [push, pull_request]
+jobs:
+  formatting-check:
+    name: Format check
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run clang-format style check for C/C++ programs.
+      uses: jidicula/[email protected]
+      with:
+        clang-format-version: '13'

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing to xsimd
+
+First, thanks for being there! Welcome on board, we will try to make your
+contributing journey as good an experience as it can be.
+
+# Submitting patches
+
+Patches should be submitted through Github PR. We di put some effort to setup a
+decent Continuous Integration coverage, please try to make it green ;-)
+
+We use [clang-format](https://clang.llvm.org/docs/ClangFormat.html) to keep
+the coding style consistent, a ``.clang-format`` file is shipped within the
+source, feel free to use it!
+
+# Extending the API
+
+We are open to extending the API, as long as it has been discussed either in an
+Issue or a PR. The only constraint is to add testing for new functions, and make
+sure they work on all supported architectures, not only your favorite one!
+
+# Licensing
+
+We use a shared copyright model that enables all contributors to maintain the
+copyright on their contributions. Stated otherwise, there's no copyright
+assignment.

benchmark/main.cpp

@@ -1,20 +1,20 @@
 /***************************************************************************
-* Copyright (c) Johan Mabille, Sylvain Corlay, Wolf Vollprecht and         *
-* Martin Renou                                                             *
-* Copyright (c) QuantStack                                                 *
-* Copyright (c) Serge Guelton                                              *
-*                                                                          *
-* Distributed under the terms of the BSD 3-Clause License.                 *
-*                                                                          *
-* The full license is in the file LICENSE, distributed with this software. *
-****************************************************************************/
+ * Copyright (c) Johan Mabille, Sylvain Corlay, Wolf Vollprecht and         *
+ * Martin Renou                                                             *
+ * Copyright (c) QuantStack                                                 *
+ * Copyright (c) Serge Guelton                                              *
+ *                                                                          *
+ * Distributed under the terms of the BSD 3-Clause License.                 *
+ *                                                                          *
+ * The full license is in the file LICENSE, distributed with this software. *
+ ****************************************************************************/
 
 #include "xsimd_benchmark.hpp"
 #include <map>
 
 void benchmark_operation()
 {
-    //std::size_t size = 9984;
+    // std::size_t size = 9984;
     std::size_t size = 20000;
     xsimd::run_benchmark_2op(xsimd::add_fn(), std::cout, size, 1000);
     xsimd::run_benchmark_2op(xsimd::sub_fn(), std::cout, size, 1000);
@@ -111,16 +111,16 @@ void benchmark_basic_math()
 
 int main(int argc, char* argv[])
 {
-    const std::map<std::string, std::pair<std::string, void(*)()>> fn_map = {
-        {"op", {"arithmetic", benchmark_operation}},
-        {"exp", {"exponential and logarithm", benchmark_exp_log}},
-        {"trigo", {"trigonometric", benchmark_trigo}},
-        {"hyperbolic", {"hyperbolic", benchmark_hyperbolic}},
-        {"power", {"power", benchmark_power}},
-        {"basic_math", {"basic math", benchmark_basic_math}},
-        {"rounding", {"rounding", benchmark_rounding}},
+    const std::map<std::string, std::pair<std::string, void (*)()>> fn_map = {
+        { "op", { "arithmetic", benchmark_operation } },
+        { "exp", { "exponential and logarithm", benchmark_exp_log } },
+        { "trigo", { "trigonometric", benchmark_trigo } },
+        { "hyperbolic", { "hyperbolic", benchmark_hyperbolic } },
+        { "power", { "power", benchmark_power } },
+        { "basic_math", { "basic math", benchmark_basic_math } },
+        { "rounding", { "rounding", benchmark_rounding } },
 #ifdef XSIMD_POLY_BENCHMARKS
-        {"utils", {"polynomial evaluation", benchmark_poly_evaluation}},
+        { "utils", { "polynomial evaluation", benchmark_poly_evaluation } },
 #endif
     };
 
@@ -129,7 +129,7 @@ int main(int argc, char* argv[])
         if (std::string(argv[1]) == "--help" || std::string(argv[1]) == "-h")
         {
             std::cout << "Available options:" << std::endl;
-            for(auto const& kv : fn_map)
+            for (auto const& kv : fn_map)
             {
                 std::cout << kv.first << ": run benchmark on " << kv.second.first << " functions" << std::endl;
             }
@@ -144,7 +144,7 @@ int main(int argc, char* argv[])
     }
     else
     {
-        for(auto const& kv : fn_map)
+        for (auto const& kv : fn_map)
         {
             kv.second.second();
         }