From a38a48daec793c0ad57398b3989eacdfcf746bdf Mon Sep 17 00:00:00 2001 From: Dong Hun Lee <59181952+ldh4@users.noreply.github.com> Date: Thu, 11 Jan 2024 13:48:10 -0700 Subject: [PATCH] Update RangePolicy and MDRangePolicy on the bounds precondition (#485) * Added a note on bounds precondition in RangePolicy and MDRangePolicy * Modified formatting * Fixed wording --- docs/source/API/core/policies/MDRangePolicy.rst | 4 ++++ docs/source/API/core/policies/RangePolicy.rst | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/source/API/core/policies/MDRangePolicy.rst b/docs/source/API/core/policies/MDRangePolicy.rst index 7d7162f2a..fa78361b8 100644 --- a/docs/source/API/core/policies/MDRangePolicy.rst +++ b/docs/source/API/core/policies/MDRangePolicy.rst @@ -86,6 +86,10 @@ 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. +Preconditions: + +* The start index must not be greater than the matching end index for all ranks. + Examples -------- diff --git a/docs/source/API/core/policies/RangePolicy.rst b/docs/source/API/core/policies/RangePolicy.rst index 4ffc85fa4..31a2a4811 100644 --- a/docs/source/API/core/policies/RangePolicy.rst +++ b/docs/source/API/core/policies/RangePolicy.rst @@ -114,6 +114,10 @@ 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. +Preconditions: + +* The start index must not be greater than the end index. + Examples --------