Deploy: 25e7177

Author: array-api-bot

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

@@ -340,7 +340,7 @@ <h1 id="extensions-generated-array-api-fft-fft--page-root">fft<a class="headerli
 <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>x</strong> (<em>array</em>) – input array. Should have a complex-valued floating-point data type.</p></li>
+<li><p><strong>x</strong> (<em>array</em>) – input array. Should have a complex floating-point data type.</p></li>
 <li><p><strong>n</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – <p>number of elements over which to compute the transform along the axis (dimension) specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code>. Let <code class="docutils literal notranslate"><span class="pre">M</span></code> be the size of the input array along the axis specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code>. When <code class="docutils literal notranslate"><span class="pre">n</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">n</span></code> equal to <code class="docutils literal notranslate"><span class="pre">M</span></code>.</p>
 <ul>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">n</span></code> is greater than <code class="docutils literal notranslate"><span class="pre">M</span></code>, the axis specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code> must be zero-padded to size <code class="docutils literal notranslate"><span class="pre">n</span></code>.</p></li>

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

@@ -340,7 +340,7 @@ <h1 id="extensions-generated-array-api-fft-fftn--page-root">fftn<a class="header
 <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>x</strong> (<em>array</em>) – input array. Should have a complex-valued floating-point data type.</p></li>
+<li><p><strong>x</strong> (<em>array</em>) – input array. Should have a complex 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 <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>

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

@@ -336,7 +336,7 @@ <h1 id="extensions-generated-array-api-fft-hfft--page-root">hfft<a class="header
 <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>x</strong> (<em>array</em>) – input array. Should have a complex-valued floating-point data type.</p></li>
+<li><p><strong>x</strong> (<em>array</em>) – input array. Should have a complex floating-point data type.</p></li>
 <li><p><strong>n</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – <p>number of elements along the transformed axis (dimension) specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code> in the <strong>output array</strong>. Let <code class="docutils literal notranslate"><span class="pre">M</span></code> be the size of the input array along the axis specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code>. When <code class="docutils literal notranslate"><span class="pre">n</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">n</span></code> equal to <code class="docutils literal notranslate"><span class="pre">2*(M-1)</span></code>.</p>
 <ul>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">n//2+1</span></code> is greater than <code class="docutils literal notranslate"><span class="pre">M</span></code>, the axis of the input array specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code> must be zero-padded to length <code class="docutils literal notranslate"><span class="pre">n//2+1</span></code>.</p></li>

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

@@ -340,7 +340,7 @@ <h1 id="extensions-generated-array-api-fft-ifft--page-root">ifft<a class="header
 <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>x</strong> (<em>array</em>) – input array. Should have a complex-valued floating-point data type.</p></li>
+<li><p><strong>x</strong> (<em>array</em>) – input array. Should have a complex floating-point data type.</p></li>
 <li><p><strong>n</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – <p>number of elements over which to compute the transform along the axis (dimension) specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code>. Let <code class="docutils literal notranslate"><span class="pre">M</span></code> be the size of the input array along the axis specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code>. When <code class="docutils literal notranslate"><span class="pre">n</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">n</span></code> equal to <code class="docutils literal notranslate"><span class="pre">M</span></code>.</p>
 <ul>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">n</span></code> is greater than <code class="docutils literal notranslate"><span class="pre">M</span></code>, the axis specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code> must be zero-padded to size <code class="docutils literal notranslate"><span class="pre">n</span></code>.</p></li>

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

@@ -340,7 +340,7 @@ <h1 id="extensions-generated-array-api-fft-ifftn--page-root">ifftn<a class="head
 <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>x</strong> (<em>array</em>) – input array. Should have a complex-valued floating-point data type.</p></li>
+<li><p><strong>x</strong> (<em>array</em>) – input array. Should have a complex 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 <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>

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

@@ -340,7 +340,7 @@ <h1 id="extensions-generated-array-api-fft-irfft--page-root">irfft<a class="head
 <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>x</strong> (<em>array</em>) – input array. Should have a complex-valued floating-point data type.</p></li>
+<li><p><strong>x</strong> (<em>array</em>) – input array. Should have a complex floating-point data type.</p></li>
 <li><p><strong>n</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – <p>number of elements along the transformed axis (dimension) specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code> in the <strong>output array</strong>. Let <code class="docutils literal notranslate"><span class="pre">M</span></code> be the size of the input array along the axis specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code>. When <code class="docutils literal notranslate"><span class="pre">n</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">n</span></code> equal to <code class="docutils literal notranslate"><span class="pre">2*(M-1)</span></code>.</p>
 <ul>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">n//2+1</span></code> is greater than <code class="docutils literal notranslate"><span class="pre">M</span></code>, the axis of the input array specified by <code class="docutils literal notranslate"><span class="pre">axis</span></code> must be zero-padded to size <code class="docutils literal notranslate"><span class="pre">n//2+1</span></code>.</p></li>

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

@@ -340,7 +340,7 @@ <h1 id="extensions-generated-array-api-fft-irfftn--page-root">irfftn<a class="he
 <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>x</strong> (<em>array</em>) – input array. Should have a complex-valued floating-point data type.</p></li>
+<li><p><strong>x</strong> (<em>array</em>) – input array. Should have a complex 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 along the transformed axes (dimensions) specified by <code class="docutils literal notranslate"><span class="pre">axes</span></code> in the <strong>output array</strong>. 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>, except for the last transformed axis in which <code class="docutils literal notranslate"><span class="pre">s[i]</span></code> equals <code class="docutils literal notranslate"><span class="pre">2*(M[i]-1)</span></code>. For each <code class="docutils literal notranslate"><span class="pre">i</span></code>, let <code class="docutils literal notranslate"><span class="pre">n</span></code> equal <code class="docutils literal notranslate"><span class="pre">s[i]</span></code>, except for the last transformed axis in which <code class="docutils literal notranslate"><span class="pre">n</span></code> equals <code class="docutils literal notranslate"><span class="pre">s[i]//2+1</span></code>.</p>
 <ul>
 <li><p>If <code class="docutils literal notranslate"><span class="pre">n</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> of the input array must be zero-padded to size <code class="docutils literal notranslate"><span class="pre">n</span></code>.</p></li>