From 2bf564225405409879aee7e0fe94156015a9f0af Mon Sep 17 00:00:00 2001 From: Dong Hun Lee Date: Thu, 11 Jan 2024 09:46:15 -0700 Subject: [PATCH] Added a note on bounds precondition in RangePolicy and MDRangePolicy --- docs/source/API/core/policies/MDRangePolicy.rst | 5 +++++ docs/source/API/core/policies/RangePolicy.rst | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/docs/source/API/core/policies/MDRangePolicy.rst b/docs/source/API/core/policies/MDRangePolicy.rst index 7d7162f2a..55a899849 100644 --- a/docs/source/API/core/policies/MDRangePolicy.rst +++ b/docs/source/API/core/policies/MDRangePolicy.rst @@ -86,6 +86,11 @@ Constructors * Provide a start and end index as well as the tiling dimensions. The length of the lists must match the rank of the policy. +``Notes``: +^^^^^^^^^^ + +* Provided start index must not be greater than the matching end index for all ranks. Otherwise, ``Kokkos::abort()`` is called. + Examples -------- diff --git a/docs/source/API/core/policies/RangePolicy.rst b/docs/source/API/core/policies/RangePolicy.rst index 4ffc85fa4..6a23e1c41 100644 --- a/docs/source/API/core/policies/RangePolicy.rst +++ b/docs/source/API/core/policies/RangePolicy.rst @@ -114,6 +114,11 @@ Optional ``InitArgs``: * ``ChunkSize`` : Provide a hint for optimal chunk-size to be used during scheduling. For the SYCL backend, the workgroup size used in a ``parallel_for`` kernel can be set via this variable. +``Notes``: +^^^^^^^^^^ + +* Provided start index must not be greater than the end index. Otherwise, ``Kokkos::abort()`` is called. + Examples --------