Deploy: 4e402cc

data-apis · Feb 26, 2025 · 8c3f169 · 8c3f169
1 parent bcc0b92
commit 8c3f169
Show file tree

Hide file tree

Showing 64 changed files with 1,477 additions and 239 deletions.
diff --git a/2022.12/changelog.html b/2022.12/changelog.html
diff --git a/2022.12/searchindex.js b/2022.12/searchindex.js
diff --git a/2023.12/changelog.html b/2023.12/changelog.html
diff --git a/2023.12/searchindex.js b/2023.12/searchindex.js
diff --git a/draft/API_specification/generated/array_api.add.html b/draft/API_specification/generated/array_api.add.html
@@ -542,6 +542,9 @@ <h1 id="api-specification-generated-array-api-add--page-root">add<a class="heade
 <div class="versionchanged">
 <p><span class="versionmodified changed">Changed in version 2022.12: </span>Added complex data type support.</p>
 </div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Added scalar argument support.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.array.__dlpack__.html b/draft/API_specification/generated/array_api.array.__dlpack__.html
@@ -607,11 +607,14 @@ <h1 id="api-specification-generated-array-api-array-dlpack--page-root">__dlpack_
 <p><span class="versionmodified changed">Changed in version 2022.12: </span>Added BufferError.</p>
 </div>
 <div class="versionchanged">
-<p><span class="versionmodified changed">Changed in version 2023.12: </span>Added the <code class="docutils literal notranslate"><span class="pre">max_version</span></code>, <code class="docutils literal notranslate"><span class="pre">dl_device</span></code>, and <code class="docutils literal notranslate"><span class="pre">copy</span></code> keywords.</p>
+<p><span class="versionmodified changed">Changed in version 2023.12: </span>Added the <code class="docutils literal notranslate"><span class="pre">max_version</span></code>, <code class="docutils literal notranslate"><span class="pre">dl_device</span></code>, and <code class="docutils literal notranslate"><span class="pre">copy</span></code> keyword arguments.</p>
 </div>
 <div class="versionchanged">
 <p><span class="versionmodified changed">Changed in version 2023.12: </span>Added recommendation for handling read-only arrays.</p>
 </div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Resolved conflicting exception guidance.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.array.__eq__.html b/draft/API_specification/generated/array_api.array.__eq__.html
@@ -485,6 +485,9 @@ <h1 id="api-specification-generated-array-api-array-eq--page-root">__eq__<a clas
 <div class="versionchanged">
 <p><span class="versionmodified changed">Changed in version 2022.12: </span>Added complex data type support.</p>
 </div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Cross-kind comparisons are explicitly left unspecified.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.array.__ge__.html b/draft/API_specification/generated/array_api.array.__ge__.html
@@ -483,6 +483,9 @@ <h1 id="api-specification-generated-array-api-array-ge--page-root">__ge__<a clas
 <li><p>Comparison of arrays without a corresponding promotable data type (see <a class="reference internal" href="../type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>) is undefined and thus implementation-dependent.</p></li>
 <li><p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Cross-kind comparisons are explicitly left unspecified.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.array.__getitem__.html b/draft/API_specification/generated/array_api.array.__getitem__.html
@@ -482,6 +482,9 @@ <h1 id="api-specification-generated-array-api-array-getitem--page-root">__getite
 <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>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Clarified that iteration is defined for one-dimensional arrays.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.array.__gt__.html b/draft/API_specification/generated/array_api.array.__gt__.html
@@ -483,6 +483,9 @@ <h1 id="api-specification-generated-array-api-array-gt--page-root">__gt__<a clas
 <li><p>Comparison of arrays without a corresponding promotable data type (see <a class="reference internal" href="../type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>) is undefined and thus implementation-dependent.</p></li>
 <li><p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Cross-kind comparisons are explicitly left unspecified.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.array.__le__.html b/draft/API_specification/generated/array_api.array.__le__.html
@@ -483,6 +483,9 @@ <h1 id="api-specification-generated-array-api-array-le--page-root">__le__<a clas
 <li><p>Comparison of arrays without a corresponding promotable data type (see <a class="reference internal" href="../type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>) is undefined and thus implementation-dependent.</p></li>
 <li><p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Cross-kind comparisons are explicitly left unspecified.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.array.__lt__.html b/draft/API_specification/generated/array_api.array.__lt__.html
@@ -483,6 +483,9 @@ <h1 id="api-specification-generated-array-api-array-lt--page-root">__lt__<a clas
 <li><p>Comparison of arrays without a corresponding promotable data type (see <a class="reference internal" href="../type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>) is undefined and thus implementation-dependent.</p></li>
 <li><p>For backward compatibility, conforming implementations may support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see <a class="reference internal" href="../../design_topics/complex_numbers.html#complex-number-ordering"><span class="std std-ref">Complex Number Ordering</span></a>).</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Cross-kind comparisons are explicitly left unspecified.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.array.__ne__.html b/draft/API_specification/generated/array_api.array.__ne__.html
@@ -485,6 +485,9 @@ <h1 id="api-specification-generated-array-api-array-ne--page-root">__ne__<a clas
 <div class="versionchanged">
 <p><span class="versionmodified changed">Changed in version 2022.12: </span>Added complex data type support.</p>
 </div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Cross-kind comparisons are explicitly left unspecified.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.atan2.html b/draft/API_specification/generated/array_api.atan2.html
@@ -514,6 +514,9 @@ <h1 id="api-specification-generated-array-api-atan2--page-root">atan2<a class="h
 <li><p>If <code class="docutils literal notranslate"><span class="pre">x1_i</span></code> is <code class="docutils literal notranslate"><span class="pre">-infinity</span></code> and <code class="docutils literal notranslate"><span class="pre">x2_i</span></code> is <code class="docutils literal notranslate"><span class="pre">+infinity</span></code>, the result is an implementation-dependent approximation to <code class="docutils literal notranslate"><span class="pre">-π/4</span></code>.</p></li>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">x1_i</span></code> is <code class="docutils literal notranslate"><span class="pre">-infinity</span></code> and <code class="docutils literal notranslate"><span class="pre">x2_i</span></code> is <code class="docutils literal notranslate"><span class="pre">-infinity</span></code>, the result is an implementation-dependent approximation to <code class="docutils literal notranslate"><span class="pre">-3π/4</span></code>.</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Added scalar argument support.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.bitwise_and.html b/draft/API_specification/generated/array_api.bitwise_and.html
@@ -481,6 +481,9 @@ <h1 id="api-specification-generated-array-api-bitwise-and--page-root">bitwise_an
 <ul class="simple">
 <li><p>At least one of <code class="docutils literal notranslate"><span class="pre">x1</span></code> or <code class="docutils literal notranslate"><span class="pre">x2</span></code> must be an array.</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Added scalar argument support.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.bitwise_left_shift.html b/draft/API_specification/generated/array_api.bitwise_left_shift.html
@@ -481,6 +481,9 @@ <h1 id="api-specification-generated-array-api-bitwise-left-shift--page-root">bit
 <ul class="simple">
 <li><p>At least one of <code class="docutils literal notranslate"><span class="pre">x1</span></code> or <code class="docutils literal notranslate"><span class="pre">x2</span></code> must be an array.</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Added scalar argument support.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.bitwise_or.html b/draft/API_specification/generated/array_api.bitwise_or.html
@@ -481,6 +481,9 @@ <h1 id="api-specification-generated-array-api-bitwise-or--page-root">bitwise_or<
 <ul class="simple">
 <li><p>At least one of <code class="docutils literal notranslate"><span class="pre">x1</span></code> or <code class="docutils literal notranslate"><span class="pre">x2</span></code> must be an array.</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Added scalar argument support.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.bitwise_right_shift.html b/draft/API_specification/generated/array_api.bitwise_right_shift.html
@@ -485,6 +485,9 @@ <h1 id="api-specification-generated-array-api-bitwise-right-shift--page-root">bi
 <ul class="simple">
 <li><p>At least one of <code class="docutils literal notranslate"><span class="pre">x1</span></code> or <code class="docutils literal notranslate"><span class="pre">x2</span></code> must be an array.</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Added scalar argument support.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.bitwise_xor.html b/draft/API_specification/generated/array_api.bitwise_xor.html
@@ -481,6 +481,9 @@ <h1 id="api-specification-generated-array-api-bitwise-xor--page-root">bitwise_xo
 <ul class="simple">
 <li><p>At least one of <code class="docutils literal notranslate"><span class="pre">x1</span></code> or <code class="docutils literal notranslate"><span class="pre">x2</span></code> must be an array.</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Added scalar argument support.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.broadcast_to.html b/draft/API_specification/generated/array_api.broadcast_to.html
@@ -474,7 +474,10 @@ <h1 id="api-specification-generated-array-api-broadcast-to--page-root">broadcast
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><strong>out</strong> (<em>array</em>) – an array having the specified shape. Must have the same data type as <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p>
+<dd class="field-even"><ul class="simple">
+<li><p><strong>out</strong> (<em>array</em>) – an array having the specified shape. Must have the same data type as <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
+<li><p><strong>.. versionchanged:: 2024.12</strong> – Clarified broadcast behavior.</p></li>
+</ul>
 </dd>
 </dl>
 </dd></dl>

diff --git a/draft/API_specification/generated/array_api.can_cast.html b/draft/API_specification/generated/array_api.can_cast.html
@@ -482,6 +482,9 @@ <h1 id="api-specification-generated-array-api-can-cast--page-root">can_cast<a cl
 <li><p>When <code class="docutils literal notranslate"><span class="pre">from_</span></code> is a data type, the function must determine whether the data type can be cast to another data type according to the complete type promotion rules (see <a class="reference internal" href="../type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>) described in this specification, irrespective of whether a conforming array library supports devices which do not have full data type support.</p></li>
 <li><p>When <code class="docutils literal notranslate"><span class="pre">from_</span></code> is an array, the function must determine whether the data type of the array can be cast to the desired data type according to the type promotion graph of the array device. As not all devices can support all data types, full support for type promotion rules (see <a class="reference internal" href="../type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>) may not be possible. Accordingly, the output of <code class="docutils literal notranslate"><span class="pre">can_cast(array,</span> <span class="pre">dtype)</span></code> may differ from <code class="docutils literal notranslate"><span class="pre">can_cast(array.dtype,</span> <span class="pre">dtype)</span></code>.</p></li>
 </ul>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Required that the application of type promotion rules must account for device context.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.clip.html b/draft/API_specification/generated/array_api.clip.html
@@ -496,6 +496,15 @@ <h1 id="api-specification-generated-array-api-clip--page-root">clip<a class="hea
 <div class="versionadded">
 <p><span class="versionmodified added">New in version 2023.12.</span></p>
 </div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Added special case behavior when one of the operands is <code class="docutils literal notranslate"><span class="pre">NaN</span></code>.</p>
+</div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Clarified that behavior is only defined when <code class="docutils literal notranslate"><span class="pre">x</span></code>, <code class="docutils literal notranslate"><span class="pre">min</span></code>, and <code class="docutils literal notranslate"><span class="pre">max</span></code> resolve to arrays having the same data type.</p>
+</div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Clarified that behavior is only defined when elements of <code class="docutils literal notranslate"><span class="pre">min</span></code> and <code class="docutils literal notranslate"><span class="pre">max</span></code> are inside the bounds of the input array data type.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.conj.html b/draft/API_specification/generated/array_api.conj.html
@@ -489,6 +489,9 @@ <h1 id="api-specification-generated-array-api-conj--page-root">conj<a class="hea
 <div class="versionadded">
 <p><span class="versionmodified added">New in version 2022.12.</span></p>
 </div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Added support for real-valued arrays.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.copysign.html b/draft/API_specification/generated/array_api.copysign.html
@@ -500,6 +500,9 @@ <h1 id="api-specification-generated-array-api-copysign--page-root">copysign<a cl
 <div class="versionadded">
 <p><span class="versionmodified added">New in version 2023.12.</span></p>
 </div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Added scalar argument support.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.count_nonzero.html b/draft/API_specification/generated/array_api.count_nonzero.html
@@ -483,6 +483,9 @@ <h1 id="api-specification-generated-array-api-count-nonzero--page-root">count_no
 <li><p>If <code class="docutils literal notranslate"><span class="pre">x</span></code> has a complex floating-point data type, non-zero elements are those elements having at least one component (real or imaginary) which is non-zero.</p></li>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">x</span></code> has a boolean data type, non-zero elements are those elements which are equal to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
 </ul>
+<div class="versionadded">
+<p><span class="versionmodified added">New in version 2024.12.</span></p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.cumulative_prod.html b/draft/API_specification/generated/array_api.cumulative_prod.html
@@ -498,6 +498,9 @@ <h1 id="api-specification-generated-array-api-cumulative-prod--page-root">cumula
 </ul>
 <p><strong>Special Cases</strong></p>
 <p>For both real-valued and complex floating-point operands, special cases must be handled as if the operation is implemented by successive application of <a class="reference internal" href="array_api.multiply.html#array_api.multiply" title="array_api.multiply"><code class="xref py py-func docutils literal notranslate"><span class="pre">multiply()</span></code></a>.</p>
+<div class="versionadded">
+<p><span class="versionmodified added">New in version 2024.12.</span></p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.cumulative_sum.html b/draft/API_specification/generated/array_api.cumulative_sum.html
@@ -501,6 +501,9 @@ <h1 id="api-specification-generated-array-api-cumulative-sum--page-root">cumulat
 <div class="versionadded">
 <p><span class="versionmodified added">New in version 2023.12.</span></p>
 </div>
+<div class="versionchanged">
+<p><span class="versionmodified changed">Changed in version 2024.12: </span>Behavior when providing a zero-dimensional array is explicitly left unspecified.</p>
+</div>
 </dd></dl>
 </section>
 

diff --git a/draft/API_specification/generated/array_api.diff.html b/draft/API_specification/generated/array_api.diff.html
@@ -491,6 +491,9 @@ <h1 id="api-specification-generated-array-api-diff--page-root">diff<a class="hea
 <li><p>The first-order differences are given by <code class="docutils literal notranslate"><span class="pre">out[i]</span> <span class="pre">=</span> <span class="pre">x[i+1]</span> <span class="pre">-</span> <span class="pre">x[i]</span></code> along a specified axis. Higher-order differences must be calculated recursively (e.g., by calling <code class="docutils literal notranslate"><span class="pre">diff(out,</span> <span class="pre">axis=axis,</span> <span class="pre">n=n-1)</span></code>).</p></li>
 <li><p>If a conforming implementation chooses to support <code class="docutils literal notranslate"><span class="pre">prepend</span></code> and <code class="docutils literal notranslate"><span class="pre">append</span></code> arrays which have a different data type than <code class="docutils literal notranslate"><span class="pre">x</span></code>, behavior is unspecified and thus implementation-defined. Implementations may choose to type promote (<a class="reference internal" href="../type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>), cast <code class="docutils literal notranslate"><span class="pre">prepend</span></code> and/or <code class="docutils literal notranslate"><span class="pre">append</span></code> to the same data type as <code class="docutils literal notranslate"><span class="pre">x</span></code>, or raise an exception.</p></li>
 </ul>
+<div class="versionadded">
+<p><span class="versionmodified added">New in version 2024.12.</span></p>
+</div>
 </dd></dl>
 </section>