Deploying to deploy-doc-site from @ 1b68d98 🚀

API/core/policies/TeamPolicy.html

@@ -677,7 +677,7 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
 <dt class="sig sig-object cppkokkos" id="_CPPv4I0ENK10TeamPolicy13team_size_maxEiRK11FunctorTypeRK17ParallelReduceTag">
 <span id="_CPPv3I0ENK10TeamPolicy13team_size_maxERK11FunctorTypeRK17ParallelReduceTag"></span><span id="_CPPv2I0ENK10TeamPolicy13team_size_maxERK11FunctorTypeRK17ParallelReduceTag"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FunctorType</span></span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">team_size_max</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0ENK10TeamPolicy13team_size_maxEiRK11FunctorTypeRK17ParallelReduceTag" title="TeamPolicy::team_size_max::FunctorType"><span class="n"><span class="pre">FunctorType</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">f</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ParallelReduceTag</span></span><span class="p"><span class="pre">&amp;</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="p"><span class="pre">;</span></span><a class="headerlink" href="#_CPPv4I0ENK10TeamPolicy13team_size_maxEiRK11FunctorTypeRK17ParallelReduceTag" title="Permalink to this definition">#</a><br /></dt>
 <dd><p>Query the maximum team size possible given a specific functor. The tag denotes whether this is for a <a class="reference external" href="../parallel-dispatch/parallel_for.html"><code class="xref cppkokkos cppkokkos-func docutils literal notranslate"><span class="pre">parallel_for()</span></code></a> or a <a class="reference external" href="../parallel-dispatch/parallel_reduce.html"><code class="xref cppkokkos cppkokkos-func docutils literal notranslate"><span class="pre">parallel_reduce()</span></code></a>.
-Note: this is not a static function! The function will take into account settings for vector length and scratch size of <code class="docutils literal notranslate"><span class="pre">*this</span></code>. 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 <code class="docutils literal notranslate"><span class="pre">*this</span></code>. 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 <code class="docutils literal notranslate"><span class="pre">team_size</span></code> allowed to be given to be used with an otherwise identical <code class="docutils literal notranslate"><span class="pre">TeamPolicy</span></code> for dispatching the functor <code class="docutils literal notranslate"><span class="pre">f</span></code>.</p>
 </dd></dl>
 
@@ -690,7 +690,7 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
 <dt class="sig sig-object cppkokkos" id="_CPPv4I0ENK10TeamPolicy21team_size_recommendedEiRK11FunctorTypeRK17ParallelReduceTag">
 <span id="_CPPv3I0ENK10TeamPolicy21team_size_recommendedERK11FunctorTypeRK17ParallelReduceTag"></span><span id="_CPPv2I0ENK10TeamPolicy21team_size_recommendedERK11FunctorTypeRK17ParallelReduceTag"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FunctorType</span></span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">team_size_recommended</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0ENK10TeamPolicy21team_size_recommendedEiRK11FunctorTypeRK17ParallelReduceTag" title="TeamPolicy::team_size_recommended::FunctorType"><span class="n"><span class="pre">FunctorType</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">f</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ParallelReduceTag</span></span><span class="p"><span class="pre">&amp;</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="p"><span class="pre">;</span></span><a class="headerlink" href="#_CPPv4I0ENK10TeamPolicy21team_size_recommendedEiRK11FunctorTypeRK17ParallelReduceTag" title="Permalink to this definition">#</a><br /></dt>
 <dd><p>Query the recommended team size for the specific functor <code class="docutils literal notranslate"><span class="pre">f</span></code>. The tag denotes whether this is for a <a class="reference external" href="../parallel-dispatch/parallel_for.html"><code class="xref cppkokkos cppkokkos-func docutils literal notranslate"><span class="pre">parallel_for()</span></code></a> or a <a class="reference external" href="../parallel-dispatch/parallel_reduce.html"><code class="xref cppkokkos cppkokkos-func docutils literal notranslate"><span class="pre">parallel_reduce()</span></code></a>.
-Note: this is not a static function! The function will take into account settings for vector length and scratch size of <code class="docutils literal notranslate"><span class="pre">*this</span></code>.
+Note: this is not a static function! The function will take into account settings for vector length and scratch size of <code class="docutils literal notranslate"><span class="pre">*this</span></code>. 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 <code class="docutils literal notranslate"><span class="pre">team_size</span></code> to be given to be used with an otherwise identical <code class="docutils literal notranslate"><span class="pre">TeamPolicy</span></code> for dispatching the functor <code class="docutils literal notranslate"><span class="pre">f</span></code>.</p>
 </dd></dl>
 

_sources/API/core/policies/TeamPolicy.rst.txt

@@ -120,15 +120,15 @@ Description
    .. cppkokkos:function:: template<class FunctorType> 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<class FunctorType> int team_size_recommended(const FunctorType& f, const ParallelForTag&) const;
 
    .. cppkokkos:function:: template<class FunctorType> 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();

_static/API/core/policies/TeamPolicy.rst

@@ -120,15 +120,15 @@ Description
    .. cppkokkos:function:: template<class FunctorType> 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<class FunctorType> int team_size_recommended(const FunctorType& f, const ParallelForTag&) const;
 
    .. cppkokkos:function:: template<class FunctorType> 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();