deploy: fa4c9fe

pull/1341/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: cbb13a9f6533c31d83f3fabbff7fdd46
+config: 6b84e77b5877c371c1624a9df0f8fc31
 tags: 645f666f9bcd5a90fca523b33c5a78b7

pull/1341/_sources/autoapi/numba_dpex/experimental/_kernel_dpcpp_spirv_overloads/_index_space_id_overloads/index.rst.txt

@@ -27,20 +27,16 @@ Overview
      - Declares global external spirv constant
    * - :py:obj:`generate_index_overload <numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.generate_index_overload>`\ (_type, _intrinsic)
      - Generates overload for the index method that generates specific IR from
+   * - :py:obj:`register_index_const_methods <numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_index_const_methods>`\ ()
+     - Register indexing related methods that can be defined as spirv const.
    * - :py:obj:`ol_nd_item_get_group <numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_get_group>`\ (nd_item)
      - SPIR-V overload for :meth:`numba_dpex.kernel_api.NdItem.get_group`.
    * - :py:obj:`ol_nd_item_dimensions <numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_dimensions>`\ (item)
      - SPIR-V overload for :meth:`numba_dpex.kernel_api.<generic_item>.dimensions`.
+   * - :py:obj:`register_jitable_method <numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_jitable_method>`\ (type_, method)
+     - Register a regular python method that can be executed by the
 
 
-.. list-table:: Attributes
-   :header-rows: 0
-   :widths: auto
-   :class: summarytable
-
-   * - :py:obj:`ol_index_func <numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_index_func>`
-     - \-
-
 
 
 Functions
@@ -61,6 +57,11 @@ Functions
    provided intrinsic.
 
 
+.. py:function:: register_index_const_methods()
+
+   Register indexing related methods that can be defined as spirv const.
+
+
 .. py:function:: ol_nd_item_get_group(nd_item)
 
    SPIR-V overload for :meth:`numba_dpex.kernel_api.NdItem.get_group`.
@@ -79,12 +80,15 @@ Functions
    `sycl::<generic_item>::dimensions` attribute.
 
 
+.. py:function:: register_jitable_method(type_, method)
+
+   Register a regular python method that can be executed by the
+   python interpreter and can be compiled into a nopython
+   function when referenced by other jit'ed functions.
+
+   Same as register_jitable, but for methods with no arguments.
 
-Attributes
-----------
-.. py:data:: ol_index_func
 
-   
 
 
 

pull/1341/_sources/autoapi/numba_dpex/kernel_api/index.rst.txt

@@ -320,6 +320,8 @@ Classes
         - Get the linear id associated with this item for all dimensions.
       * - :py:obj:`get_id <numba_dpex.kernel_api.Item.get_id>`\ (idx)
         - Get the id for a specific dimension.
+      * - :py:obj:`get_linear_range <numba_dpex.kernel_api.Item.get_linear_range>`\ ()
+        - Return the total number of work-items in the work-group.
       * - :py:obj:`get_range <numba_dpex.kernel_api.Item.get_range>`\ (idx)
         - Get the range size for a specific dimension.
 
@@ -343,6 +345,11 @@ Classes
       :rtype: int
 
 
+   .. py:method:: get_linear_range()
+
+      Return the total number of work-items in the work-group.
+
+
    .. py:method:: get_range(idx)
 
       Get the range size for a specific dimension.
@@ -381,6 +388,10 @@ Classes
         - Get the global range size for a specific dimension.
       * - :py:obj:`get_local_range <numba_dpex.kernel_api.NdItem.get_local_range>`\ (idx)
         - Get the local range size for a specific dimension.
+      * - :py:obj:`get_local_linear_range <numba_dpex.kernel_api.NdItem.get_local_linear_range>`\ ()
+        - Return the total number of work-items in the work-group.
+      * - :py:obj:`get_global_linear_range <numba_dpex.kernel_api.NdItem.get_global_linear_range>`\ ()
+        - Return the total number of work-items in the work-group.
       * - :py:obj:`get_group <numba_dpex.kernel_api.NdItem.get_group>`\ ()
         - Returns the group.
 
@@ -436,6 +447,16 @@ Classes
       :rtype: int
 
 
+   .. py:method:: get_local_linear_range()
+
+      Return the total number of work-items in the work-group.
+
+
+   .. py:method:: get_global_linear_range()
+
+      Return the total number of work-items in the work-group.
+
+
    .. py:method:: get_group()
 
       Returns the group.

pull/1341/_sources/autoapi/numba_dpex/kernel_api/index_space_ids/index.rst.txt

@@ -124,6 +124,8 @@ Classes
         - Get the linear id associated with this item for all dimensions.
       * - :py:obj:`get_id <numba_dpex.kernel_api.index_space_ids.Item.get_id>`\ (idx)
         - Get the id for a specific dimension.
+      * - :py:obj:`get_linear_range <numba_dpex.kernel_api.index_space_ids.Item.get_linear_range>`\ ()
+        - Return the total number of work-items in the work-group.
       * - :py:obj:`get_range <numba_dpex.kernel_api.index_space_ids.Item.get_range>`\ (idx)
         - Get the range size for a specific dimension.
 
@@ -147,6 +149,11 @@ Classes
       :rtype: int
 
 
+   .. py:method:: get_linear_range()
+
+      Return the total number of work-items in the work-group.
+
+
    .. py:method:: get_range(idx)
 
       Get the range size for a specific dimension.
@@ -185,6 +192,10 @@ Classes
         - Get the global range size for a specific dimension.
       * - :py:obj:`get_local_range <numba_dpex.kernel_api.index_space_ids.NdItem.get_local_range>`\ (idx)
         - Get the local range size for a specific dimension.
+      * - :py:obj:`get_local_linear_range <numba_dpex.kernel_api.index_space_ids.NdItem.get_local_linear_range>`\ ()
+        - Return the total number of work-items in the work-group.
+      * - :py:obj:`get_global_linear_range <numba_dpex.kernel_api.index_space_ids.NdItem.get_global_linear_range>`\ ()
+        - Return the total number of work-items in the work-group.
       * - :py:obj:`get_group <numba_dpex.kernel_api.index_space_ids.NdItem.get_group>`\ ()
         - Returns the group.
 
@@ -240,6 +251,16 @@ Classes
       :rtype: int
 
 
+   .. py:method:: get_local_linear_range()
+
+      Return the total number of work-items in the work-group.
+
+
+   .. py:method:: get_global_linear_range()
+
+      Return the total number of work-items in the work-group.
+
+
    .. py:method:: get_group()
 
       Returns the group.

pull/1341/autoapi/numba_dpex/experimental/_kernel_dpcpp_spirv_overloads/_index_space_id_overloads/index.html

@@ -263,21 +263,17 @@ <h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">
 <tr class="row-odd"><td><p><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.generate_index_overload" title="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.generate_index_overload"><code class="xref py py-obj docutils literal notranslate"><span class="pre">generate_index_overload</span></code></a>(_type, _intrinsic)</p></td>
 <td><p>Generates overload for the index method that generates specific IR from</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_get_group" title="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_get_group"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ol_nd_item_get_group</span></code></a>(nd_item)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_index_const_methods" title="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_index_const_methods"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_index_const_methods</span></code></a>()</p></td>
+<td><p>Register indexing related methods that can be defined as spirv const.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_get_group" title="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_get_group"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ol_nd_item_get_group</span></code></a>(nd_item)</p></td>
 <td><p>SPIR-V overload for <a class="reference internal" href="../../../kernel_api/index.html#numba_dpex.kernel_api.NdItem.get_group" title="numba_dpex.kernel_api.NdItem.get_group"><code class="xref py py-meth docutils literal notranslate"><span class="pre">numba_dpex.kernel_api.NdItem.get_group()</span></code></a>.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_dimensions" title="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_dimensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ol_nd_item_dimensions</span></code></a>(item)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_dimensions" title="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_dimensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ol_nd_item_dimensions</span></code></a>(item)</p></td>
 <td><p>SPIR-V overload for <code class="xref py py-meth docutils literal notranslate"><span class="pre">numba_dpex.kernel_api.&lt;generic_item&gt;.dimensions()</span></code>.</p></td>
 </tr>
-</tbody>
-</table>
-</div>
-<div class="table-wrapper colwidths-auto summarytable docutils container" id="id2">
-<table class="summarytable docutils align-default" id="id2">
-<caption><span class="caption-text">Attributes</span><a class="headerlink" href="#id2" title="Link to this table">#</a></caption>
-<tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_index_func" title="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_index_func"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ol_index_func</span></code></a></p></td>
-<td><p>-</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_jitable_method" title="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_jitable_method"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_jitable_method</span></code></a>(<a href="#id2"><span class="problematic" id="id3">type_</span></a>, method)</p></td>
+<td><p>Register a regular python method that can be executed by the</p></td>
 </tr>
 </tbody>
 </table>
@@ -304,6 +300,12 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
 provided intrinsic.</p>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_index_const_methods">
+<span class="sig-name descname"><span class="pre">register_index_const_methods</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_index_const_methods" title="Link to this definition">#</a></dt>
+<dd><p>Register indexing related methods that can be defined as spirv const.</p>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_get_group">
 <span class="sig-name descname"><span class="pre">ol_nd_item_get_group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nd_item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_get_group" title="Link to this definition">#</a></dt>
@@ -325,13 +327,14 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
 <cite>sycl::&lt;generic_item&gt;::dimensions</cite> attribute.</p>
 </dd></dl>
 
-</section>
-<section id="attributes">
-<h2>Attributes<a class="headerlink" href="#attributes" title="Link to this heading">#</a></h2>
-<dl class="py data">
-<dt class="sig sig-object py" id="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_index_func">
-<span class="sig-name descname"><span class="pre">ol_index_func</span></span><a class="headerlink" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_index_func" title="Link to this definition">#</a></dt>
-<dd></dd></dl>
+<dl class="py function">
+<dt class="sig sig-object py" id="numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_jitable_method">
+<span class="sig-name descname"><span class="pre">register_jitable_method</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type_</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_jitable_method" title="Link to this definition">#</a></dt>
+<dd><p>Register a regular python method that can be executed by the
+python interpreter and can be compiled into a nopython
+function when referenced by other jit’ed functions.</p>
+<p>Same as register_jitable, but for methods with no arguments.</p>
+</dd></dl>
 
 </section>
 </section>
@@ -382,12 +385,10 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
 <li><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.spirv_name"><code class="docutils literal notranslate"><span class="pre">spirv_name()</span></code></a></li>
 <li><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.declare_spirv_const"><code class="docutils literal notranslate"><span class="pre">declare_spirv_const()</span></code></a></li>
 <li><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.generate_index_overload"><code class="docutils literal notranslate"><span class="pre">generate_index_overload()</span></code></a></li>
+<li><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_index_const_methods"><code class="docutils literal notranslate"><span class="pre">register_index_const_methods()</span></code></a></li>
 <li><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_get_group"><code class="docutils literal notranslate"><span class="pre">ol_nd_item_get_group()</span></code></a></li>
 <li><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_nd_item_dimensions"><code class="docutils literal notranslate"><span class="pre">ol_nd_item_dimensions()</span></code></a></li>
-</ul>
-</li>
-<li><a class="reference internal" href="#attributes">Attributes</a><ul>
-<li><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.ol_index_func"><code class="docutils literal notranslate"><span class="pre">ol_index_func</span></code></a></li>
+<li><a class="reference internal" href="#numba_dpex.experimental._kernel_dpcpp_spirv_overloads._index_space_id_overloads.register_jitable_method"><code class="docutils literal notranslate"><span class="pre">register_jitable_method()</span></code></a></li>
 </ul>
 </li>
 </ul>