Add descriptions for tile size getters in MDRangePolicy (#563)

* Added descriptions for tile_size_recommended and max_total_tile_size in RangePolicy * Update docs/source/API/core/policies/MDRangePolicy.rst Co-authored-by: Daniel Arndt <[email protected]> * Update docs/source/API/core/policies/MDRangePolicy.rst Co-authored-by: Damien L-G <[email protected]> * Added a note about tile size getters being availalbe since Kokkos 4.5 --------- Co-authored-by: Daniel Arndt <[email protected]> Co-authored-by: Damien L-G <[email protected]>
kokkos · Aug 14, 2024 · b30fe1a · b30fe1a
1 parent 2c87476
commit b30fe1a
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/source/API/core/policies/MDRangePolicy.rst b/docs/source/API/core/policies/MDRangePolicy.rst
@@ -117,6 +117,20 @@ CTAD Constructors (since 4.3)
    MDRangePolicy pa4(ses, abegin, aend);
    MDRangePolicy pa5(ses, abegin, aend, atiling);
 
+Member Functions
+^^^^^^^^^^^^^^^^
+.. cppkokkos:function:: tile_type tile_size_recommended() const
+
+    * Returns a ``Kokkos::Array<array_index_type, rank>`` type containing per-rank tile sizes that ``MDRangePolicy`` internally uses by default. The default tile sizes are static and are set based on the specified backend.
+
+    .. note:: ``tile_size_recommended()`` available since Kokkos 4.5
+
+.. cppkokkos:function:: int max_total_tile_size() const
+
+    * Returns a value that represents the upper limit for the product of all tile sizes.
+
+    .. note:: ``max_total_tile_size()`` available since Kokkos 4.5
+
 Notes
 ^^^^^