Deploy: 474ec2b

Author: array-api-bot

2022.12/extensions/generated/array_api.fft.fftn.html

@@ -340,16 +340,17 @@ <h1 id="extensions-generated-array-api-fft-fftn--page-root">fftn<a class="header
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>x</strong> (<em>array</em>) – input array. Should have a complex-valued floating-point data type.</p></li>
-<li><p><strong>s</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em>) – <p>number of elements over which to compute the transform along the axes (dimensions) specified by <code class="docutils literal notranslate"><span class="pre">axes</span></code>. Let <code class="docutils literal notranslate"><span class="pre">i</span></code> be the index of the nth axis specified by <code class="docutils literal notranslate"><span class="pre">axes</span></code> and <code class="docutils literal notranslate"><span class="pre">M[i]</span></code> be the size of the input array along axis <code class="docutils literal notranslate"><span class="pre">i</span></code>. When <code class="docutils literal notranslate"><span class="pre">s</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the function must set <code class="docutils literal notranslate"><span class="pre">s</span></code> equal to a sequence of integers, such that, for all <code class="docutils literal notranslate"><span class="pre">i</span></code>, <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> equals <code class="docutils literal notranslate"><span class="pre">M[i]</span></code>.</p>
+<li><p><strong>s</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em>) – <p>number of elements over which to compute the transform along the axes (dimensions) specified by <code class="docutils literal notranslate"><span class="pre">axes</span></code>. Let <code class="docutils literal notranslate"><span class="pre">i</span></code> be the index of the <code class="docutils literal notranslate"><span class="pre">n</span></code>-th axis specified by <code class="docutils literal notranslate"><span class="pre">axes</span></code> (i.e., <code class="docutils literal notranslate"><span class="pre">i</span> <span class="pre">=</span> <span class="pre">axes[n]</span></code>) and <code class="docutils literal notranslate"><span class="pre">M[i]</span></code> be the size of the input array along axis <code class="docutils literal notranslate"><span class="pre">i</span></code>. When <code class="docutils literal notranslate"><span class="pre">s</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the function must set <code class="docutils literal notranslate"><span class="pre">s</span></code> equal to a sequence of integers such that <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> equals <code class="docutils literal notranslate"><span class="pre">M[i]</span></code> for all <code class="docutils literal notranslate"><span class="pre">i</span></code>.</p>
 <ul>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> is greater than <code class="docutils literal notranslate"><span class="pre">M[i]</span></code>, axis <code class="docutils literal notranslate"><span class="pre">i</span></code> must be zero-padded to size <code class="docutils literal notranslate"><span class="pre">s[i]</span></code>.</p></li>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> is less than <code class="docutils literal notranslate"><span class="pre">M[i]</span></code>, axis <code class="docutils literal notranslate"><span class="pre">i</span></code> must be trimmed to size <code class="docutils literal notranslate"><span class="pre">s[i]</span></code>.</p></li>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> equals <code class="docutils literal notranslate"><span class="pre">M[i]</span></code> or <code class="docutils literal notranslate"><span class="pre">-1</span></code>, all elements along axis <code class="docutils literal notranslate"><span class="pre">i</span></code> must be used when computing the transform.</p></li>
 </ul>
 <p>If <code class="docutils literal notranslate"><span class="pre">s</span></code> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">axes</span></code> must not be <code class="docutils literal notranslate"><span class="pre">None</span></code>. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
 </p></li>
-<li><p><strong>axes</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em>) – <p>axes (dimensions) over which to compute the transform. A valid axis must be an integer on the interval <code class="docutils literal notranslate"><span class="pre">[-N,</span> <span class="pre">N)</span></code>, where <code class="docutils literal notranslate"><span class="pre">N</span></code> is the rank (number of dimensions) of <code class="docutils literal notranslate"><span class="pre">x</span></code>. If an axis is specified as a negative integer, the function must determine the axis along which to compute the transform by counting backward from the last dimension (where <code class="docutils literal notranslate"><span class="pre">-1</span></code> refers to the last dimension).</p>
+<li><p><strong>axes</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em>) – <p>axes (dimensions) over which to compute the transform. A valid axis in <code class="docutils literal notranslate"><span class="pre">axes</span></code> must be an integer on the interval <code class="docutils literal notranslate"><span class="pre">[-N,</span> <span class="pre">N)</span></code>, where <code class="docutils literal notranslate"><span class="pre">N</span></code> is the rank (number of dimensions) of <code class="docutils literal notranslate"><span class="pre">x</span></code>. If an axis is specified as a negative integer, the function must determine the axis along which to compute the transform by counting backward from the last dimension (where <code class="docutils literal notranslate"><span class="pre">-1</span></code> refers to the last dimension).</p>
 <p>If <code class="docutils literal notranslate"><span class="pre">s</span></code> is provided, the corresponding <code class="docutils literal notranslate"><span class="pre">axes</span></code> to be transformed must also be provided. If <code class="docutils literal notranslate"><span class="pre">axes</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the function must compute the transform over all axes. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
+<p>If <code class="docutils literal notranslate"><span class="pre">axes</span></code> contains two or more entries which resolve to the same axis (i.e., resolved axes are not unique), the behavior is unspecified and thus implementation-defined.</p>
 </p></li>
 <li><p><strong>norm</strong> (<em>Literal</em><em>[</em><em>'backward'</em><em>, </em><em>'ortho'</em><em>, </em><em>'forward'</em><em>]</em>) – <p>normalization mode. Should be one of the following modes:</p>
 <ul>

2022.12/extensions/generated/array_api.fft.fftshift.html

@@ -341,7 +341,9 @@ <h1 id="extensions-generated-array-api-fft-fftshift--page-root">fftshift<a class
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>x</strong> (<em>array</em>) – input array. Should have a floating-point data type.</p></li>
-<li><p><strong>axes</strong> (<em>Optional</em><em>[</em><em>Union</em><em>[</em><em>int</em><em>, </em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em><em>]</em>) – axes over which to shift. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, the function must shift all axes. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p></li>
+<li><p><strong>axes</strong> (<em>Optional</em><em>[</em><em>Union</em><em>[</em><em>int</em><em>, </em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em><em>]</em>) – <p>axes over which to shift. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, the function must shift all axes. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
+<p>If <code class="docutils literal notranslate"><span class="pre">axes</span></code> contains two or more entries which resolve to the same axis (i.e., resolved axes are not unique), the behavior is unspecified and thus implementation-defined.</p>
+</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>

2022.12/extensions/generated/array_api.fft.ifftn.html

@@ -340,16 +340,17 @@ <h1 id="extensions-generated-array-api-fft-ifftn--page-root">ifftn<a class="head
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>x</strong> (<em>array</em>) – input array. Should have a complex-valued floating-point data type.</p></li>
-<li><p><strong>s</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em>) – <p>number of elements over which to compute the transform along the axes (dimensions) specified by <code class="docutils literal notranslate"><span class="pre">axes</span></code>. Let <code class="docutils literal notranslate"><span class="pre">i</span></code> be the index of the nth axis specified by <code class="docutils literal notranslate"><span class="pre">axes</span></code> and <code class="docutils literal notranslate"><span class="pre">M[i]</span></code> be the size of the input array along axis <code class="docutils literal notranslate"><span class="pre">i</span></code>. When <code class="docutils literal notranslate"><span class="pre">s</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the function must set <code class="docutils literal notranslate"><span class="pre">s</span></code> equal to a sequence of integers, such that, for all <code class="docutils literal notranslate"><span class="pre">i</span></code>, <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> equals <code class="docutils literal notranslate"><span class="pre">M[i]</span></code>.</p>
+<li><p><strong>s</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em>) – <p>number of elements over which to compute the transform along the axes (dimensions) specified by <code class="docutils literal notranslate"><span class="pre">axes</span></code>. Let <code class="docutils literal notranslate"><span class="pre">i</span></code> be the index of the <code class="docutils literal notranslate"><span class="pre">n</span></code>-th axis specified by <code class="docutils literal notranslate"><span class="pre">axes</span></code> (i.e., <code class="docutils literal notranslate"><span class="pre">i</span> <span class="pre">=</span> <span class="pre">axes[n]</span></code>) and <code class="docutils literal notranslate"><span class="pre">M[i]</span></code> be the size of the input array along axis <code class="docutils literal notranslate"><span class="pre">i</span></code>. When <code class="docutils literal notranslate"><span class="pre">s</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the function must set <code class="docutils literal notranslate"><span class="pre">s</span></code> equal to a sequence of integers such that <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> equals <code class="docutils literal notranslate"><span class="pre">M[i]</span></code> for all <code class="docutils literal notranslate"><span class="pre">i</span></code>.</p>
 <ul>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> is greater than <code class="docutils literal notranslate"><span class="pre">M[i]</span></code>, axis <code class="docutils literal notranslate"><span class="pre">i</span></code> must be zero-padded to size <code class="docutils literal notranslate"><span class="pre">s[i]</span></code>.</p></li>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> is less than <code class="docutils literal notranslate"><span class="pre">M[i]</span></code>, axis <code class="docutils literal notranslate"><span class="pre">i</span></code> must be trimmed to size <code class="docutils literal notranslate"><span class="pre">s[i]</span></code>.</p></li>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> equals <code class="docutils literal notranslate"><span class="pre">M[i]</span></code> or <code class="docutils literal notranslate"><span class="pre">-1</span></code>, all elements along axis <code class="docutils literal notranslate"><span class="pre">i</span></code> must be used when computing the transform.</p></li>
 </ul>
 <p>If <code class="docutils literal notranslate"><span class="pre">s</span></code> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">axes</span></code> must not be <code class="docutils literal notranslate"><span class="pre">None</span></code>. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
 </p></li>
-<li><p><strong>axes</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em>) – <p>axes (dimensions) over which to compute the transform. A valid axis must be an integer on the interval <code class="docutils literal notranslate"><span class="pre">[-N,</span> <span class="pre">N)</span></code>, where <code class="docutils literal notranslate"><span class="pre">N</span></code> is the rank (number of dimensions) of <code class="docutils literal notranslate"><span class="pre">x</span></code>. If an axis is specified as a negative integer, the function must determine the axis along which to compute the transform by counting backward from the last dimension (where <code class="docutils literal notranslate"><span class="pre">-1</span></code> refers to the last dimension).</p>
+<li><p><strong>axes</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em>) – <p>axes (dimensions) over which to compute the transform. A valid axis in <code class="docutils literal notranslate"><span class="pre">axes</span></code> must be an integer on the interval <code class="docutils literal notranslate"><span class="pre">[-N,</span> <span class="pre">N)</span></code>, where <code class="docutils literal notranslate"><span class="pre">N</span></code> is the rank (number of dimensions) of <code class="docutils literal notranslate"><span class="pre">x</span></code>. If an axis is specified as a negative integer, the function must determine the axis along which to compute the transform by counting backward from the last dimension (where <code class="docutils literal notranslate"><span class="pre">-1</span></code> refers to the last dimension).</p>
 <p>If <code class="docutils literal notranslate"><span class="pre">s</span></code> is provided, the corresponding <code class="docutils literal notranslate"><span class="pre">axes</span></code> to be transformed must also be provided. If <code class="docutils literal notranslate"><span class="pre">axes</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the function must compute the transform over all axes. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
+<p>If <code class="docutils literal notranslate"><span class="pre">axes</span></code> contains two or more entries which resolve to the same axis (i.e., resolved axes are not unique), the behavior is unspecified and thus implementation-defined.</p>
 </p></li>
 <li><p><strong>norm</strong> (<em>Literal</em><em>[</em><em>'backward'</em><em>, </em><em>'ortho'</em><em>, </em><em>'forward'</em><em>]</em>) – <p>specify the normalization mode. Should be one of the following modes:</p>
 <ul>

2022.12/extensions/generated/array_api.fft.ifftshift.html

@@ -340,7 +340,9 @@ <h1 id="extensions-generated-array-api-fft-ifftshift--page-root">ifftshift<a cla
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>x</strong> (<em>array</em>) – input array. Should have a floating-point data type.</p></li>
-<li><p><strong>axes</strong> (<em>Optional</em><em>[</em><em>Union</em><em>[</em><em>int</em><em>, </em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em><em>]</em>) – axes over which to perform the inverse shift. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, the function must shift all axes. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p></li>
+<li><p><strong>axes</strong> (<em>Optional</em><em>[</em><em>Union</em><em>[</em><em>int</em><em>, </em><em>Sequence</em><em>[</em><em>int</em><em>]</em><em>]</em><em>]</em>) – <p>axes over which to perform the inverse shift. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, the function must shift all axes. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
+<p>If <code class="docutils literal notranslate"><span class="pre">axes</span></code> contains two or more entries which resolve to the same axis (i.e., resolved axes are not unique), the behavior is unspecified and thus implementation-defined.</p>
+</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>