Rename ndims to dim_count and add description

uxlfoundation · Aug 27, 2024 · 966abfb · 966abfb
1 parent fb0dd45
commit 966abfb
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/source/elements/oneTBB/source/algorithms/blocked_ranges/blocked_rangeNd_cls.rst b/source/elements/oneTBB/source/algorithms/blocked_ranges/blocked_rangeNd_cls.rst
@@ -41,7 +41,7 @@ Therefore, blocked_rangeNd<int,2> is a specialisation of blocked_range2d where b
 
                 // Access
                 bool is_divisible() const;
-                static constexpr unsigned int ndims();
+                static constexpr unsigned int dim_count();
                 const tbb::blocked_range<value_type>& dim(unsigned int dimension) const;
             };
 
@@ -138,6 +138,12 @@ each subrange remain the same as in the original range.
 
 **Returns:** any dim(int) returns is_divisible().
 
+.. code:: cpp
+
+   static constexpr unsigned int dim_count();
+
+**Returns:** Number of dimensions specified by the template argument ``N``.
+
 .. code:: cpp
 
     const dim_range_type& dim(int) const;