Deploy: b933915

Author: array-api-bot

2022.12/extensions/generated/array_api.linalg.solve.html

@@ -348,11 +348,11 @@ <h1 id="extensions-generated-array-api-linalg-solve--page-root">solve<a class="h
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>x1</strong> (<em>array</em>) – coefficient array <code class="docutils literal notranslate"><span class="pre">A</span></code> having shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">M)</span></code> and whose innermost two dimensions form square matrices. Must be of full rank (i.e., all rows or, equivalently, columns must be linearly independent). Should have a floating-point data type.</p></li>
-<li><p><strong>x2</strong> (<em>array</em>) – ordinate (or “dependent variable”) array <code class="docutils literal notranslate"><span class="pre">B</span></code>. If <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(M,)</span></code>, <code class="docutils literal notranslate"><span class="pre">x2</span></code> is equivalent to an array having shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">1)</span></code>. If <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">K)</span></code>, each column <code class="docutils literal notranslate"><span class="pre">k</span></code> defines a set of ordinate values for which to compute a solution, and <code class="docutils literal notranslate"><span class="pre">shape(x2)[:-1]</span></code> must be compatible with <code class="docutils literal notranslate"><span class="pre">shape(x1)[:-1]</span></code> (see <a class="reference internal" href="../../API_specification/broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). Should have a floating-point data type.</p></li>
+<li><p><strong>x2</strong> (<em>array</em>) – ordinate (or “dependent variable”) array <code class="docutils literal notranslate"><span class="pre">B</span></code>. If <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(M,)</span></code>, <code class="docutils literal notranslate"><span class="pre">x2</span></code> is equivalent to an array having shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">1)</span></code>. If <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">K)</span></code>, each column <code class="docutils literal notranslate"><span class="pre">k</span></code> defines a set of ordinate values for which to compute a solution, and <code class="docutils literal notranslate"><span class="pre">shape(x2)[:-2]</span></code> must be compatible with <code class="docutils literal notranslate"><span class="pre">shape(x1)[:-2]</span></code> (see <a class="reference internal" href="../../API_specification/broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). Should have a floating-point data type.</p></li>
 </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 containing the solution to the system <code class="docutils literal notranslate"><span class="pre">AX</span> <span class="pre">=</span> <span class="pre">B</span></code> for each square matrix. The returned array must have the same shape as <code class="docutils literal notranslate"><span class="pre">x2</span></code> (i.e., the array corresponding to <code class="docutils literal notranslate"><span class="pre">B</span></code>) and must have a floating-point data type determined by <a class="reference internal" href="../../API_specification/type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>.</p>
+<dd class="field-even"><p><strong>out</strong> (<em>array</em>) – an array containing the solution to the system <code class="docutils literal notranslate"><span class="pre">AX</span> <span class="pre">=</span> <span class="pre">B</span></code> for each square matrix. If <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(M,)</span></code>, the returned array must have shape equal to <code class="docutils literal notranslate"><span class="pre">shape(x1)[:-2]</span> <span class="pre">+</span> <span class="pre">shape(x2)[-1:]</span></code>. Otherwise, if <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">K)`</span></code>, the returned array must have shape equal to <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">K)</span></code>, where <code class="docutils literal notranslate"><span class="pre">...</span></code> refers to the result of broadcasting <code class="docutils literal notranslate"><span class="pre">shape(x1)[:-2]</span></code> and <code class="docutils literal notranslate"><span class="pre">shape(x2)[:-2]</span></code>. The returned array must have a floating-point data type determined by <a class="reference internal" href="../../API_specification/type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>.</p>
 </dd>
 </dl>
 <p class="rubric">Notes</p>

2022.12/searchindex.js

@@ -465,7 +465,7 @@ <h1 id="api-specification-generated-array-api-unstack--page-root">unstack<a clas
 <dl class="py function">
 <dt class="sig sig-object py" id="array_api.unstack">
 <span class="sig-name descname"><span class="pre">unstack</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">axis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</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">Tuple</span><span class="p"><span class="pre">[</span></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></span><a class="headerlink" href="#array_api.unstack" title="Link to this definition">¶</a></dt>
-<dd><p>Splits an array in a sequence of arrays along the given axis.</p>
+<dd><p>Splits an array into a sequence of arrays along the given axis.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">

2023.12/API_specification/generated/array_api.unstack.html

@@ -525,7 +525,7 @@ <h2 id="objects-in-api">Objects in API<a class="headerlink" href="#objects-in-ap
 <td><p>Constructs an array by tiling an input array.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="generated/array_api.unstack.html#array_api.unstack" title="array_api.unstack"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unstack</span></code></a>(x, /, *, axis=0)</p></td>
-<td><p>Splits an array in a sequence of arrays along the given axis.</p></td>
+<td><p>Splits an array into a sequence of arrays along the given axis.</p></td>
 </tr>
 </tbody>
 </table>

2023.12/API_specification/manipulation_functions.html

@@ -355,11 +355,11 @@ <h1 id="extensions-generated-array-api-linalg-solve--page-root">solve<a class="h
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>x1</strong> (<em>array</em>) – coefficient array <code class="docutils literal notranslate"><span class="pre">A</span></code> having shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">M)</span></code> and whose innermost two dimensions form square matrices. Must be of full rank (i.e., all rows or, equivalently, columns must be linearly independent). Should have a floating-point data type.</p></li>
-<li><p><strong>x2</strong> (<em>array</em>) – ordinate (or “dependent variable”) array <code class="docutils literal notranslate"><span class="pre">B</span></code>. If <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(M,)</span></code>, <code class="docutils literal notranslate"><span class="pre">x2</span></code> is equivalent to an array having shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">1)</span></code>. If <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">K)</span></code>, each column <code class="docutils literal notranslate"><span class="pre">k</span></code> defines a set of ordinate values for which to compute a solution, and <code class="docutils literal notranslate"><span class="pre">shape(x2)[:-1]</span></code> must be compatible with <code class="docutils literal notranslate"><span class="pre">shape(x1)[:-1]</span></code> (see <a class="reference internal" href="../../API_specification/broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). Should have a floating-point data type.</p></li>
+<li><p><strong>x2</strong> (<em>array</em>) – ordinate (or “dependent variable”) array <code class="docutils literal notranslate"><span class="pre">B</span></code>. If <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(M,)</span></code>, <code class="docutils literal notranslate"><span class="pre">x2</span></code> is equivalent to an array having shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">1)</span></code>. If <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">K)</span></code>, each column <code class="docutils literal notranslate"><span class="pre">k</span></code> defines a set of ordinate values for which to compute a solution, and <code class="docutils literal notranslate"><span class="pre">shape(x2)[:-2]</span></code> must be compatible with <code class="docutils literal notranslate"><span class="pre">shape(x1)[:-2]</span></code> (see <a class="reference internal" href="../../API_specification/broadcasting.html#broadcasting"><span class="std std-ref">Broadcasting</span></a>). Should have a floating-point data type.</p></li>
 </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 containing the solution to the system <code class="docutils literal notranslate"><span class="pre">AX</span> <span class="pre">=</span> <span class="pre">B</span></code> for each square matrix. The returned array must have the same shape as <code class="docutils literal notranslate"><span class="pre">x2</span></code> (i.e., the array corresponding to <code class="docutils literal notranslate"><span class="pre">B</span></code>) and must have a floating-point data type determined by <a class="reference internal" href="../../API_specification/type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>.</p>
+<dd class="field-even"><p><strong>out</strong> (<em>array</em>) – an array containing the solution to the system <code class="docutils literal notranslate"><span class="pre">AX</span> <span class="pre">=</span> <span class="pre">B</span></code> for each square matrix. If <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(M,)</span></code>, the returned array must have shape equal to <code class="docutils literal notranslate"><span class="pre">shape(x1)[:-2]</span> <span class="pre">+</span> <span class="pre">shape(x2)[-1:]</span></code>. Otherwise, if <code class="docutils literal notranslate"><span class="pre">x2</span></code> has shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">K)`</span></code>, the returned array must have shape equal to <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">K)</span></code>, where <code class="docutils literal notranslate"><span class="pre">...</span></code> refers to the result of broadcasting <code class="docutils literal notranslate"><span class="pre">shape(x1)[:-2]</span></code> and <code class="docutils literal notranslate"><span class="pre">shape(x2)[:-2]</span></code>. The returned array must have a floating-point data type determined by <a class="reference internal" href="../../API_specification/type_promotion.html#type-promotion"><span class="std std-ref">Type Promotion Rules</span></a>.</p>
 </dd>
 </dl>
 <p class="rubric">Notes</p>

2023.12/extensions/generated/array_api.linalg.solve.html

@@ -465,7 +465,7 @@ <h1 id="api-specification-generated-array-api-unstack--page-root">unstack<a clas
 <dl class="py function">
 <dt class="sig sig-object py" id="array_api.unstack">
 <span class="sig-name descname"><span class="pre">unstack</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">array</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">axis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</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">Tuple</span><span class="p"><span class="pre">[</span></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></span><a class="headerlink" href="#array_api.unstack" title="Link to this definition">¶</a></dt>
-<dd><p>Splits an array in a sequence of arrays along the given axis.</p>
+<dd><p>Splits an array into a sequence of arrays along the given axis.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">

2023.12/searchindex.js

@@ -525,7 +525,7 @@ <h2 id="objects-in-api">Objects in API<a class="headerlink" href="#objects-in-ap
 <td><p>Constructs an array by tiling an input array.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="generated/array_api.unstack.html#array_api.unstack" title="array_api.unstack"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unstack</span></code></a>(x, /, *, axis=0)</p></td>
-<td><p>Splits an array in a sequence of arrays along the given axis.</p></td>
+<td><p>Splits an array into a sequence of arrays along the given axis.</p></td>
 </tr>
 </tbody>
 </table>