Update naming and CMake structure

Author: OliverRietmann

.github/workflows/build-and-test.yml

@@ -23,8 +23,8 @@ jobs:
         uses: actions/checkout@v4
       - name: Build Docs
         run: |
-          cmake -B ${{github.workspace}}/build
-          cmake --build ${{github.workspace}}/build/docs --target docs
+          cmake -B ${{github.workspace}}/build -DBUILD_DOCS=ON
+          cmake --build ${{github.workspace}}/build
           mv ${{github.workspace}}/build/docs/html /root/
       - name: Upload Artifact
         uses: actions/upload-artifact@v4

.github/workflows/documentation.yml

@@ -0,0 +1,62 @@
+name: Unit Tests
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - '**'
+
+permissions:
+  contents: read
+  actions: read
+  checks: write
+  pull-requests: write
+
+jobs:
+  unit-tests:
+    runs-on: cern-nextgen-h100
+    container: registry.cern.ch/ngt-wp1.7/wp1.7-soa-wrapper@sha256:16432eae6635379637e67c4cc00334c46b6dce845b83da7e75fb754d24266897
+    steps:
+      - uses: actions/checkout@v4
+        name: checkout repository
+      - name: gcc
+        env:
+          CXX: g++
+          CC: gcc
+          NVCC_CCBIN: gcc
+          CUDACXX: nvcc
+          TEST_TAG: gcc
+        run: &build-and-test |
+          cmake -B ${{github.workspace}}/build/ -DBUILD_TESTING=ON -DCMAKE_COMPILE_WARNING_AS_ERROR=ON
+          cmake --build ${{github.workspace}}/build/
+          ctest --test-dir ${{github.workspace}}/build/tests --output-on-failure --output-junit /root/test_${TEST_TAG}.xml
+          rm -rf ${{github.workspace}}/build
+      - name: clang
+        env:
+          CXX: clang++
+          CC: clang
+          NVCC_CCBIN: clang
+          CUDACXX: nvcc
+          TEST_TAG: clang
+        run: *build-and-test
+      - name: upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: junit-artifacts
+          path: |
+            /root/test_gcc.xml
+            /root/test_clang.xml
+  publish-test-results:
+    needs: unit-tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: download artifact
+        uses: actions/download-artifact@v5
+        with:
+          name: junit-artifacts
+      - name: publish test results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: (!cancelled())
+        with:
+          files: "test_*.xml"

.github/workflows/unit-tests.yml

@@ -1,12 +1,15 @@
 cmake_minimum_required(VERSION 4.0)
 project(memlayout LANGUAGES CXX)
 
-#option(ENABLE_CPU "Build CPU tests" ON)
-#option(ENABLE_CUDA "Build CUDA tests" ON)
+option(BUILD_TESTING "Build unit tests" OFF)
+option(BUILD_DOCS "Build documentation" OFF)
 
-add_library(memlayout INTERFACE)
-target_include_directories(memlayout INTERFACE include)
+add_subdirectory(memlayout)
 
-add_subdirectory(tests EXCLUDE_FROM_ALL)
+if(BUILD_TESTING)
+  add_subdirectory(tests)
+endif()
 
-add_subdirectory(docs EXCLUDE_FROM_ALL)
+if(BUILD_DOCS)
+  add_subdirectory(docs)
+endif()

CMakeLists.txt

@@ -83,7 +83,7 @@ In Step 9, instead of running nvidia-smi, execute the commands in the section [B
 ## TODO
 - Default initializations
 - Choose between uninitialized, default initialized, and custom initialized arrays
-- Allow putting default values in skeleton struct definition, e.g. by template spcialization
+- Allow putting default values in skeleton struct definition, e.g. by template specialization
 - Aggregate initialization for arrays
 - Don't define closures twice
 - Return classical reference to struct in AoS case

README.md

@@ -5,7 +5,7 @@ set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
 configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
 
-add_custom_target(docs
+add_custom_target(docs ALL
     COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
     COMMENT "Generating API documentation with Doxygen"

docs/CMakeLists.txt

@@ -17,27 +17,28 @@
 
 ```cpp
 #include <iostream>
+
 #include <memlayout.h>
 
-template <template <class> class F>
+template <template <class> class Container>
 struct Point {
     MEMLAYOUT_APPLY_UNARY(x, y, z)
     MEMLAYOUT_APPLY_BINARY(Point, MEMLAYOUT_EXPAND(x), MEMLAYOUT_EXPAND(y), MEMLAYOUT_EXPAND(z))
-    F<int> x, y, z;
+    Container<int> x, y, z;
 };
 
-template <template <class> class F>
+template <template <class> class Container>
 struct Momentum {
     MEMLAYOUT_APPLY_UNARY(p, i)
     MEMLAYOUT_APPLY_BINARY(Momentum, MEMLAYOUT_EXPAND(v), MEMLAYOUT_EXPAND(m))
-    MemLayout::wrapper<Point, F> v;
-    F<int> m;
+    memlayout::Wrapper<Point, Container> v;
+    Container<int> m;
 };
 
 int main()
 {
     constexpr int N = 10;
-    memlayout::wrapper<Momentum, int[N], memlayout::format::soa> p{};
+    memlayout::Wrapper<Momentum, int[N], memlayout::Layout::soa> p{};
     for (int n = 0; n < N; ++n) {
         p[n].v.x = N - n;
         std::cout << p[n].v.x << ", ";