From c989d4d9c6696d4a2c6a4ede1449df3197f681da Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Thu, 10 Oct 2024 09:43:35 -0400 Subject: [PATCH] team_size_max/recommended: Clarify that team_size should be checked --- docs/source/API/core/policies/TeamPolicy.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/API/core/policies/TeamPolicy.rst b/docs/source/API/core/policies/TeamPolicy.rst index c3b89b047..544cd59f6 100644 --- a/docs/source/API/core/policies/TeamPolicy.rst +++ b/docs/source/API/core/policies/TeamPolicy.rst @@ -120,7 +120,7 @@ Description .. cppkokkos:function:: template int team_size_max(const FunctorType& f, const ParallelReduceTag&) const; Query the maximum team size possible given a specific functor. The tag denotes whether this is for a |parallelFor|_ or a |parallelReduce|_. - Note: this is not a static function! The function will take into account settings for vector length and scratch size of ``*this``. Using a value larger than the return value will result in dispatch failure. + Note: this is not a static function! The function will take into account settings for vector length and scratch size of ``*this``. Using a value larger than the return value will result in dispatch failure. If the value returned is non-positive, no valid team size could be found. A common reason is that too much scratch cache memory was requested. Returns: The maximum value for ``team_size`` allowed to be given to be used with an otherwise identical ``TeamPolicy`` for dispatching the functor ``f``. .. cppkokkos:function:: template int team_size_recommended(const FunctorType& f, const ParallelForTag&) const; @@ -128,7 +128,7 @@ Description .. cppkokkos:function:: template int team_size_recommended(const FunctorType& f, const ParallelReduceTag&) const; Query the recommended team size for the specific functor ``f``. The tag denotes whether this is for a |parallelFor|_ or a |parallelReduce|_. - Note: this is not a static function! The function will take into account settings for vector length and scratch size of ``*this``. + Note: this is not a static function! The function will take into account settings for vector length and scratch size of ``*this``. If the value returned is non-positive, no valid team size could be found. A common reason is that too much scratch cache memory was requested. Returns: The recommended value for ``team_size`` to be given to be used with an otherwise identical ``TeamPolicy`` for dispatching the functor ``f``. .. cppkokkos:function:: static int vector_length_max();