fix some typos and mismatches between documentation and code

alpaka-group · Sep 30, 2020 · d771bb7 · d771bb7
1 parent df4d192
commit d771bb7
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 24 deletions.
diff --git a/docs/pages/api.rst b/docs/pages/api.rst
@@ -31,9 +31,9 @@ Array domain
 
 .. doxygenstruct:: llama::ArrayDomain
 
-.. doxygenstruct:: llama::ArrayDomainCoordIterator
+.. doxygenstruct:: llama::ArrayDomainIndexIterator
    :members:
-.. doxygenstruct:: llama::ArrayDomainCoordRange
+.. doxygenstruct:: llama::ArrayDomainIndexRange
    :members:
 
 Datum domain

diff --git a/docs/pages/mappings.rst b/docs/pages/mappings.rst
@@ -31,7 +31,7 @@ Every mapping needs to fulfill the following concept:
 
 That is, each Mapping type needs to expose the types :cpp:`M::ArrayDomain` and :cpp:`M::DatumDomain`.
 Furthermore, each mapping needs to provide a static constexpr member variable :cpp:`blobCount` and two member functions.
-:cpp:`getBlobSize(i)` gives the size in bytes of the :cpp:`i`th block of memory needed for this mapping.
+:cpp:`getBlobSize(i)` gives the size in bytes of the :cpp:`i`\ th block of memory needed for this mapping.
 :cpp:`i` is in the range of :cpp:`0` to :cpp:`blobCount - 1`.
 :cpp:`getBlobNrAndOffset(ud)` implements the core mapping logic by translating a array domain coordinate :cpp:`ud` into a value of :cpp:`NrAndOffset`, containing the blob number of offset within the blob where the value should be stored.
 
@@ -55,17 +55,17 @@ clang, cuda, intel, msvc):
 
 .. code-block:: C++
 
-    llama::mapping::SoA<ArrayDomain, DatumDomain> mapping{userDomainSize};
+    llama::mapping::SoA<ArrayDomain, DatumDomain> mapping{arrayDomainSize};
 
     // or using CTAD and an unused argument for the datum domain:
-    llama::mapping::SoA mapping{userDomainSize, DatumDomain{});
+    llama::mapping::SoA mapping{arrayDomainSize, DatumDomain{});
 
 .. code-block:: C++
 
-    llama::mapping::AoS<ArrayDomain, DatumDomain> mapping{userDomainSize};
+    llama::mapping::AoS<ArrayDomain, DatumDomain> mapping{arrayDomainSize};
 
     // or using CTAD and an unused argument for the datum domain:
-    llama::mapping::AoS mapping{userDomainSize, DatumDomain{});
+    llama::mapping::AoS mapping{arrayDomainSize, DatumDomain{});
 
 The template parameters are deduced using CTAD.
 
@@ -74,7 +74,7 @@ but, since the mapping code is more complicated, compilers currently fail to aut
 
 .. code-block:: C++
 
-    llama::mapping::AoSoA<ArrayDomain, DatumDomain, Lanes> mapping{userDomainSize};
+    llama::mapping::AoSoA<ArrayDomain, DatumDomain, Lanes> mapping{arrayDomainSize};
 
 .. _label-tree-mapping:
 
@@ -152,13 +152,13 @@ a further constructor parameter for the instantiation of this tuple.
     >;
 
     Mapping mapping(
-        userDomainSize,
+        arrayDomainSize,
         treeOperationList
     );
 
     // or using CTAD and an unused argument for the datum domain:
     llama::mapping::tree::Mapping mapping(
-        userDomainSize,
+        arrayDomainSize,
         llama::Tuple{
             llama::mapping::tree::functor::LeafOnlyRT()
         },

diff --git a/include/llama/ForEach.hpp b/include/llama/ForEach.hpp
@@ -44,12 +44,12 @@ namespace llama
     /// datum domain tree.
     /// \param baseCoord \ref DatumCoord at which the iteration should be
     /// started. The functor is called on elements beneath this coordinate.
-    template <typename DatumDomain, typename Functor, std::size_t... Coord>
-    LLAMA_FN_HOST_ACC_INLINE void forEach(Functor&& functor, DatumCoord<Coord...> baseCoord)
+    template <typename DatumDomain, typename Functor, std::size_t... Coords>
+    LLAMA_FN_HOST_ACC_INLINE void forEach(Functor&& functor, DatumCoord<Coords...> baseCoord)
     {
         LLAMA_FORCE_INLINE_RECURSIVE
         internal::applyFunctorForEachLeaf(
-            GetType<DatumDomain, DatumCoord<Coord...>> {},
+            GetType<DatumDomain, DatumCoord<Coords...>> {},
             baseCoord,
             std::forward<Functor>(functor));
     }

diff --git a/include/llama/mapping/AoS.hpp b/include/llama/mapping/AoS.hpp
@@ -15,7 +15,7 @@ namespace llama::mapping
     template <
         typename T_UserDomain,
         typename T_DatumDomain,
-        typename LinearizeUserDomainFunctor = LinearizeUserDomainCpp>
+        typename LinearizeUserDomainFunctor = LinearizeArrayDomainCpp>
     struct AoS
     {
         using ArrayDomain = T_UserDomain;

diff --git a/include/llama/mapping/AoSoA.hpp b/include/llama/mapping/AoSoA.hpp
@@ -18,7 +18,7 @@ namespace llama::mapping
         typename T_UserDomain,
         typename T_DatumDomain,
         std::size_t Lanes,
-        typename LinearizeUserDomainFunctor = LinearizeUserDomainCpp>
+        typename LinearizeUserDomainFunctor = LinearizeArrayDomainCpp>
     struct AoSoA
     {
         using ArrayDomain = T_UserDomain;

diff --git a/include/llama/mapping/Common.hpp b/include/llama/mapping/Common.hpp
@@ -23,7 +23,7 @@ namespace llama::mapping
 
     /// Functor that maps a \ref ArrayDomain coordinate into linear numbers the
     /// way C++ arrays work.
-    struct LinearizeUserDomainCpp
+    struct LinearizeArrayDomainCpp
     {
         template <std::size_t Dim>
         LLAMA_FN_HOST_ACC_INLINE constexpr auto size(const ArrayDomain<Dim>& size) -> std::size_t
@@ -52,7 +52,7 @@ namespace llama::mapping
 
     /// Functor that maps a \ref ArrayDomain coordinate into linear numbers the
     /// way Fortran arrays work.
-    struct LinearizeUserDomainFortran
+    struct LinearizeArrayDomainFortran
     {
         template <std::size_t Dim>
         LLAMA_FN_HOST_ACC_INLINE constexpr auto size(const ArrayDomain<Dim>& size) -> std::size_t
@@ -81,7 +81,7 @@ namespace llama::mapping
 
     /// Functor that maps a \ref ArrayDomain coordinate into linear numbers using
     /// the Z-order space filling curve (Morton codes).
-    struct LinearizeUserDomainMorton
+    struct LinearizeArrayDomainMorton
     {
         template <std::size_t Dim>
         LLAMA_FN_HOST_ACC_INLINE constexpr auto size(const ArrayDomain<Dim>& size) const -> std::size_t

diff --git a/include/llama/mapping/SoA.hpp b/include/llama/mapping/SoA.hpp
@@ -16,7 +16,7 @@ namespace llama::mapping
     template <
         typename T_UserDomain,
         typename T_DatumDomain,
-        typename LinearizeUserDomainFunctor = LinearizeUserDomainCpp>
+        typename LinearizeUserDomainFunctor = LinearizeArrayDomainCpp>
     struct SoA
     {
         using ArrayDomain = T_UserDomain;

diff --git a/tests/mapping.cpp b/tests/mapping.cpp
@@ -87,7 +87,7 @@ TEST_CASE("address.AoS.fortran")
 {
     using ArrayDomain = llama::ArrayDomain<2>;
     auto arrayDomain = ArrayDomain {16, 16};
-    auto mapping = llama::mapping::AoS<ArrayDomain, Particle, llama::mapping::LinearizeUserDomainFortran> {arrayDomain};
+    auto mapping = llama::mapping::AoS<ArrayDomain, Particle, llama::mapping::LinearizeArrayDomainFortran> {arrayDomain};
 
     {
         const auto coord = ArrayDomain {0, 0};
@@ -139,7 +139,7 @@ TEST_CASE("address.AoS.morton")
 {
     using ArrayDomain = llama::ArrayDomain<2>;
     auto arrayDomain = ArrayDomain {16, 16};
-    auto mapping = llama::mapping::AoS<ArrayDomain, Particle, llama::mapping::LinearizeUserDomainMorton> {arrayDomain};
+    auto mapping = llama::mapping::AoS<ArrayDomain, Particle, llama::mapping::LinearizeArrayDomainMorton> {arrayDomain};
 
     {
         const auto coord = ArrayDomain {0, 0};
@@ -243,7 +243,7 @@ TEST_CASE("address.SoA.fortran")
 {
     using ArrayDomain = llama::ArrayDomain<2>;
     auto arrayDomain = ArrayDomain {16, 16};
-    auto mapping = llama::mapping::SoA<ArrayDomain, Particle, llama::mapping::LinearizeUserDomainFortran> {arrayDomain};
+    auto mapping = llama::mapping::SoA<ArrayDomain, Particle, llama::mapping::LinearizeArrayDomainFortran> {arrayDomain};
 
     {
         const auto coord = ArrayDomain {0, 0};
@@ -299,7 +299,7 @@ TEST_CASE("address.SoA.morton")
 
     using ArrayDomain = llama::ArrayDomain<2>;
     auto arrayDomain = ArrayDomain {16, 16};
-    auto mapping = llama::mapping::SoA<ArrayDomain, Particle, llama::mapping::LinearizeUserDomainMorton> {arrayDomain};
+    auto mapping = llama::mapping::SoA<ArrayDomain, Particle, llama::mapping::LinearizeArrayDomainMorton> {arrayDomain};
 
     {
         const auto coord = ArrayDomain {0, 0};

diff --git a/tests/userdomain.cpp b/tests/userdomain.cpp
@@ -163,7 +163,7 @@ TEST_CASE("Morton")
     using ArrayDomain = llama::ArrayDomain<2>;
     ArrayDomain arrayDomain {2, 3};
 
-    llama::mapping::LinearizeUserDomainMorton lin;
+    llama::mapping::LinearizeArrayDomainMorton lin;
     CHECK(lin.size(ArrayDomain {2, 3}) == 4 * 4);
     CHECK(lin.size(ArrayDomain {2, 4}) == 4 * 4);
     CHECK(lin.size(ArrayDomain {2, 5}) == 8 * 8);