Skip to content

Commit

Permalink
Deploying to gh-pages from @ 62f4ac3 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
lucascolley committed Dec 15, 2024
1 parent 7f941c0 commit 93b14ed
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 20 deletions.
6 changes: 3 additions & 3 deletions generated/array_api_extra.atleast_nd.html
Original file line number Diff line number Diff line change
Expand Up @@ -266,13 +266,13 @@ <h1>array_api_extra.atleast_nd<a class="headerlink" href="#array-api-extra-atlea
<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>)</p></li>
<li><p><strong>x</strong> (<em>array</em>) – Input array.</p></li>
<li><p><strong>ndim</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The minimum number of dimensions for the result.</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>x</cite>. Default: infer</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>x</cite>. Default: infer.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>res</strong>An array with <code class="docutils literal notranslate"><span class="pre">res.ndim</span></code> &gt;= <cite>ndim</cite>.
<dd class="field-even"><p>An array with <code class="docutils literal notranslate"><span class="pre">res.ndim</span></code> &gt;= <cite>ndim</cite>.
If <code class="docutils literal notranslate"><span class="pre">x.ndim</span></code> &gt;= <cite>ndim</cite>, <cite>x</cite> is returned.
If <code class="docutils literal notranslate"><span class="pre">x.ndim</span></code> &lt; <cite>ndim</cite>, <cite>x</cite> is expanded by prepending new axes
until <code class="docutils literal notranslate"><span class="pre">res.ndim</span></code> equals <cite>ndim</cite>.</p>
Expand Down
4 changes: 2 additions & 2 deletions generated/array_api_extra.cov.html
Original file line number Diff line number Diff line change
Expand Up @@ -275,11 +275,11 @@ <h1>array_api_extra.cov<a class="headerlink" href="#array-api-extra-cov" title="
<li><p><strong>m</strong> (<em>array</em>) – A 1-D or 2-D array containing multiple variables and observations.
Each row of <cite>m</cite> represents a variable, and each column a single
observation of all those variables.</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>m</cite>. Default: infer</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>m</cite>. Default: infer.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>res</strong>The covariance matrix of the variables.</p>
<dd class="field-even"><p>The covariance matrix of the variables.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>array</p>
Expand Down
6 changes: 3 additions & 3 deletions generated/array_api_extra.create_diagonal.html
Original file line number Diff line number Diff line change
Expand Up @@ -266,15 +266,15 @@ <h1>array_api_extra.create_diagonal<a class="headerlink" href="#array-api-extra-
<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>) – A 1-D array</p></li>
<li><p><strong>x</strong> (<em>array</em>) – A 1-D array.</p></li>
<li><p><strong>offset</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>, </em><em>optional</em>) – Offset from the leading diagonal (default is <code class="docutils literal notranslate"><span class="pre">0</span></code>).
Use positive ints for diagonals above the leading diagonal,
and negative ints for diagonals below the leading diagonal.</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>x</cite>. Default: infer</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>x</cite>. Default: infer.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>res</strong>A 2-D array with <cite>x</cite> on the diagonal (offset by <cite>offset</cite>).</p>
<dd class="field-even"><p>A 2-D array with <cite>x</cite> on the diagonal (offset by <cite>offset</cite>).</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>array</p>
Expand Down
6 changes: 3 additions & 3 deletions generated/array_api_extra.expand_dims.html
Original file line number Diff line number Diff line change
Expand Up @@ -270,17 +270,17 @@ <h1>array_api_extra.expand_dims<a class="headerlink" href="#array-api-extra-expa
<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>a</strong> (<em>array</em>)</p></li>
<li><p><strong>a</strong> (<em>array</em>) – Array to have its shape expanded.</p></li>
<li><p><strong>axis</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><em>tuple</em></a><em> of </em><em>ints</em><em>, </em><em>optional</em>) – Position(s) in the expanded axes where the new axis (or axes) is/are placed.
If multiple positions are provided, they should be unique (note that a position
given by a positive index could also be referred to by a negative index -
that will also result in an error).
Default: <code class="docutils literal notranslate"><span class="pre">(0,)</span></code>.</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>a</cite>. Default: infer</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>a</cite>. Default: infer.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>res</strong><cite>a</cite> with an expanded shape.</p>
<dd class="field-even"><p><cite>a</cite> with an expanded shape.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>array</p>
Expand Down
8 changes: 4 additions & 4 deletions generated/array_api_extra.kron.html
Original file line number Diff line number Diff line change
Expand Up @@ -269,13 +269,13 @@ <h1>array_api_extra.kron<a class="headerlink" href="#array-api-extra-kron" title
<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>a</strong> (<em>array</em>)</p></li>
<li><p><strong>b</strong> (<em>array</em>)</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>a</cite> and <cite>b</cite>. Default: infer</p></li>
<li><p><strong>a</strong> (<em>array</em>) – Input arrays.</p></li>
<li><p><strong>b</strong> (<em>array</em>) – Input arrays.</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>a</cite> and <cite>b</cite>. Default: infer.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>res</strong>The Kronecker product of <cite>a</cite> and <cite>b</cite>.</p>
<dd class="field-even"><p>The Kronecker product of <cite>a</cite> and <cite>b</cite>.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>array</p>
Expand Down
4 changes: 2 additions & 2 deletions generated/array_api_extra.setdiff1d.html
Original file line number Diff line number Diff line change
Expand Up @@ -271,11 +271,11 @@ <h1>array_api_extra.setdiff1d<a class="headerlink" href="#array-api-extra-setdif
<li><p><strong>x2</strong> (<em>array</em>) – Input comparison array.</p></li>
<li><p><strong>assume_unique</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – If <code class="docutils literal notranslate"><span class="pre">True</span></code>, the input arrays are both assumed to be unique, which
can speed up the calculation. Default is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>x1</cite> and <cite>x2</cite>. Default: infer</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>x1</cite> and <cite>x2</cite>. Default: infer.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>res</strong>1D array of values in <cite>x1</cite> that are not in <cite>x2</cite>. The result
<dd class="field-even"><p>1D array of values in <cite>x1</cite> that are not in <cite>x2</cite>. The result
is sorted when <cite>assume_unique</cite> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, but otherwise only sorted
if the input is sorted.</p>
</dd>
Expand Down
4 changes: 2 additions & 2 deletions generated/array_api_extra.sinc.html
Original file line number Diff line number Diff line change
Expand Up @@ -278,11 +278,11 @@ <h1>array_api_extra.sinc<a class="headerlink" href="#array-api-extra-sinc" title
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<em>array</em>) – Array (possibly multi-dimensional) of values for which to calculate
<code class="docutils literal notranslate"><span class="pre">sinc(x)</span></code>. Must have a real floating point dtype.</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>x</cite>. Default: infer</p></li>
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>x</cite>. Default: infer.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>res</strong><code class="docutils literal notranslate"><span class="pre">sinc(x)</span></code> calculated elementwise, which has the same shape as the input.</p>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">sinc(x)</span></code> calculated elementwise, which has the same shape as the input.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>array</p>
Expand Down
Loading

0 comments on commit 93b14ed

Please sign in to comment.