Deploy: 0498721

Author: array-api-bot

draft/API_specification/generated/array_api.array.__getitem__.html

@@ -464,23 +464,24 @@
 <h1 id="api-specification-generated-array-api-array-getitem--page-root">__getitem__<a class="headerlink" href="#api-specification-generated-array-api-array-getitem--page-root" title="Link to this heading">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="array_api.array.__getitem__">
-<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">slice</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ellipsis</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">slice</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ellipsis</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#array_api.array.__getitem__" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">slice</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ellipsis</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">slice</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ellipsis</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#array_api.array.__getitem__" title="Link to this definition">¶</a></dt>
 <dd><p>Returns <code class="docutils literal notranslate"><span class="pre">self[key]</span></code>.</p>
-<p>See <a class="reference internal" href="../indexing.html#indexing"><span class="std std-ref">Indexing</span></a> for details on supported indexing semantics.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>self</strong> (<em>array</em>) – array instance.</p></li>
-<li><p><strong>key</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>slice</em><em>, </em><em>ellipsis</em><em>, </em><em>None</em><em>, </em><em>Tuple</em><em>[</em><em>Union</em><em>[</em><em>int</em><em>, </em><em>slice</em><em>, </em><em>ellipsis</em><em>, </em><em>None</em><em>]</em><em>, </em><em>...</em><em>]</em><em>, </em><em>array</em><em>]</em>) – index key.</p></li>
+<li><p><strong>key</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>slice</em><em>, </em><em>ellipsis</em><em>, </em><em>None</em><em>, </em><em>Tuple</em><em>[</em><em>Union</em><em>[</em><em>int</em><em>, </em><em>slice</em><em>, </em><em>ellipsis</em><em>, </em><em>array</em><em>,  </em><em>None</em><em>]</em><em>, </em><em>...</em><em>]</em><em>, </em><em>array</em><em>]</em>) – index key.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><ul class="simple">
-<li><p><strong>out</strong> (<em>array</em>) – an array containing the accessed value(s). The returned array must have the same data type as <code class="docutils literal notranslate"><span class="pre">self</span></code>.</p></li>
-<li><p><strong>.. note::</strong> – When <code class="docutils literal notranslate"><span class="pre">__getitem__</span></code> is defined on an object, Python will automatically define iteration (i.e., the behavior from <code class="docutils literal notranslate"><span class="pre">iter(x)</span></code>) as  <code class="docutils literal notranslate"><span class="pre">x[0]</span></code>, <code class="docutils literal notranslate"><span class="pre">x[1]</span></code>, …, <code class="docutils literal notranslate"><span class="pre">x[N-1]</span></code>. This can also be implemented directly by defining <code class="docutils literal notranslate"><span class="pre">__iter__</span></code>. Therefore, for a one-dimensional array <code class="docutils literal notranslate"><span class="pre">x</span></code>, iteration should produce a sequence of zero-dimensional arrays <code class="docutils literal notranslate"><span class="pre">x[0]</span></code>, <code class="docutils literal notranslate"><span class="pre">x[1]</span></code>, …, <code class="docutils literal notranslate"><span class="pre">x[N-1]</span></code>, where <code class="docutils literal notranslate"><span class="pre">N</span></code> is the number of elements in the array. Iteration behavior for arrays having zero dimensions or more than one dimension is unspecified and thus implementation-defined.</p></li>
-</ul>
+<dd class="field-even"><p><strong>out</strong> (<em>array</em>) – an array containing the accessed value(s). The returned array must have the same data type as <code class="docutils literal notranslate"><span class="pre">self</span></code>.</p>
 </dd>
 </dl>
+<p class="rubric">Notes</p>
+<ul class="simple">
+<li><p>See <a class="reference internal" href="../indexing.html#indexing"><span class="std std-ref">Indexing</span></a> for details on supported indexing semantics.</p></li>
+<li><p>When <code class="docutils literal notranslate"><span class="pre">__getitem__</span></code> is defined on an object, Python will automatically define iteration (i.e., the behavior from <code class="docutils literal notranslate"><span class="pre">iter(x)</span></code>) as  <code class="docutils literal notranslate"><span class="pre">x[0]</span></code>, <code class="docutils literal notranslate"><span class="pre">x[1]</span></code>, …, <code class="docutils literal notranslate"><span class="pre">x[N-1]</span></code>. This can also be implemented directly by defining <code class="docutils literal notranslate"><span class="pre">__iter__</span></code>. Therefore, for a one-dimensional array <code class="docutils literal notranslate"><span class="pre">x</span></code>, iteration should produce a sequence of zero-dimensional arrays <code class="docutils literal notranslate"><span class="pre">x[0]</span></code>, <code class="docutils literal notranslate"><span class="pre">x[1]</span></code>, …, <code class="docutils literal notranslate"><span class="pre">x[N-1]</span></code>, where <code class="docutils literal notranslate"><span class="pre">N</span></code> is the number of elements in the array. Iteration behavior for arrays having zero dimensions or more than one dimension is unspecified and thus implementation-defined.</p></li>
+</ul>
 </dd></dl>
 </section>
 

draft/API_specification/generated/array_api.array.__setitem__.html

@@ -464,20 +464,25 @@
 <h1 id="api-specification-generated-array-api-array-setitem--page-root">__setitem__<a class="headerlink" href="#api-specification-generated-array-api-array-setitem--page-root" title="Link to this heading">¶</a></h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="array_api.array.__setitem__">
-<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__setitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">slice</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ellipsis</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">slice</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ellipsis</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#array_api.array.__setitem__" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">array.</span></span><span class="sig-name descname"><span class="pre">__setitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">slice</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ellipsis</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">slice</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ellipsis</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#array_api.array.__setitem__" title="Link to this definition">¶</a></dt>
 <dd><p>Sets <code class="docutils literal notranslate"><span class="pre">self[key]</span></code> to <code class="docutils literal notranslate"><span class="pre">value</span></code>.</p>
-<p>See <a class="reference internal" href="../indexing.html#indexing"><span class="std std-ref">Indexing</span></a> for details on supported indexing semantics.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>self</strong> (<em>array</em>) – array instance.</p></li>
-<li><p><strong>key</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>slice</em><em>, </em><em>ellipsis</em><em>, </em><em>Tuple</em><em>[</em><em>Union</em><em>[</em><em>int</em><em>, </em><em>slice</em><em>, </em><em>ellipsis</em><em>]</em><em>, </em><em>...</em><em>]</em><em>, </em><em>array</em><em>]</em>) – index key.</p></li>
+<li><p><strong>key</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>slice</em><em>, </em><em>ellipsis</em><em>, </em><em>Tuple</em><em>[</em><em>Union</em><em>[</em><em>int</em><em>, </em><em>slice</em><em>, </em><em>ellipsis</em><em>, </em><em>array</em><em>]</em><em>, </em><em>...</em><em>]</em><em>, </em><em>array</em><em>]</em>) – index key.</p></li>
 <li><p><strong>value</strong> (<em>Union</em><em>[</em><em>int</em><em>, </em><em>float</em><em>, </em><em>complex</em><em>, </em><em>bool</em><em>, </em><em>array</em><em>]</em>) – value(s) to set. Must be compatible with <code class="docutils literal notranslate"><span class="pre">self[key]</span></code> (see <a class="reference internal" href="../broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>).</p></li>
 </ul>
 </dd>
 </dl>
 <p class="rubric">Notes</p>
-<ul class="simple">
+<ul>
+<li><p>See <a class="reference internal" href="../indexing.html#indexing"><span class="std std-ref">Indexing</span></a> for details on supported indexing semantics.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Indexing semantics when <code class="docutils literal notranslate"><span class="pre">key</span></code> is an integer array or a tuple of integers and integer arrays is currently unspecified and thus implementation-defined. This will be revisited in a future revision of this standard.</p>
+</div>
+</li>
 <li><p>Setting array values must not affect the data type of <code class="docutils literal notranslate"><span class="pre">self</span></code>.</p></li>
 <li><p>When <code class="docutils literal notranslate"><span class="pre">value</span></code> is a Python scalar (i.e., <code class="docutils literal notranslate"><span class="pre">int</span></code>, <code class="docutils literal notranslate"><span class="pre">float</span></code>, <code class="docutils literal notranslate"><span class="pre">complex</span></code>, <code class="docutils literal notranslate"><span class="pre">bool</span></code>), behavior must follow specification guidance on mixing arrays with Python scalars (see <a class="reference internal" href="../type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>).</p></li>
 <li><p>When <code class="docutils literal notranslate"><span class="pre">value</span></code> is an <code class="docutils literal notranslate"><span class="pre">array</span></code> of a different data type than <code class="docutils literal notranslate"><span class="pre">self</span></code>, how values are cast to the data type of <code class="docutils literal notranslate"><span class="pre">self</span></code> is implementation defined.</p></li>

draft/API_specification/index.html

@@ -679,6 +679,7 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="indexing.html#multi-axis-indexing">Multi-axis Indexing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="indexing.html#integer-array-indexing">Integer Array Indexing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="indexing.html#boolean-array-indexing">Boolean Array Indexing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="indexing.html#return-values">Return Values</a></li>
 </ul>