Skip to content

Commit 067cc87

Browse files
committed
Deploying to gh-pages from @ 03f0b3e 🚀
1 parent 6075115 commit 067cc87

25 files changed

+456
-17
lines changed

_sources/api-reference.md.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
at
1010
atleast_nd
11+
broadcast_shapes
1112
cov
1213
create_diagonal
1314
expand_dims
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
array\_api\_extra.broadcast\_shapes
2+
===================================
3+
4+
.. currentmodule:: array_api_extra
5+
6+
.. autofunction:: broadcast_shapes

api-reference.html

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@
204204
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
205205
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.at.html">array_api_extra.at</a></li>
206206
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.atleast_nd.html">array_api_extra.atleast_nd</a></li>
207+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.broadcast_shapes.html">array_api_extra.broadcast_shapes</a></li>
207208
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.cov.html">array_api_extra.cov</a></li>
208209
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.create_diagonal.html">array_api_extra.create_diagonal</a></li>
209210
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.expand_dims.html">array_api_extra.expand_dims</a></li>
@@ -277,31 +278,34 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
277278
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.atleast_nd.html#array_api_extra.atleast_nd" title="array_api_extra.atleast_nd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">atleast_nd</span></code></a></p></td>
278279
<td><p>Recursively expand the dimension of an array to at least <cite>ndim</cite>.</p></td>
279280
</tr>
280-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.cov.html#array_api_extra.cov" title="array_api_extra.cov"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cov</span></code></a></p></td>
281+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.broadcast_shapes.html#array_api_extra.broadcast_shapes" title="array_api_extra.broadcast_shapes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">broadcast_shapes</span></code></a></p></td>
282+
<td><p>Compute the shape of the broadcasted arrays.</p></td>
283+
</tr>
284+
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.cov.html#array_api_extra.cov" title="array_api_extra.cov"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cov</span></code></a></p></td>
281285
<td><p>Estimate a covariance matrix.</p></td>
282286
</tr>
283-
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.create_diagonal.html#array_api_extra.create_diagonal" title="array_api_extra.create_diagonal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_diagonal</span></code></a></p></td>
287+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.create_diagonal.html#array_api_extra.create_diagonal" title="array_api_extra.create_diagonal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_diagonal</span></code></a></p></td>
284288
<td><p>Construct a diagonal array.</p></td>
285289
</tr>
286-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.expand_dims.html#array_api_extra.expand_dims" title="array_api_extra.expand_dims"><code class="xref py py-obj docutils literal notranslate"><span class="pre">expand_dims</span></code></a></p></td>
290+
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.expand_dims.html#array_api_extra.expand_dims" title="array_api_extra.expand_dims"><code class="xref py py-obj docutils literal notranslate"><span class="pre">expand_dims</span></code></a></p></td>
287291
<td><p>Expand the shape of an array.</p></td>
288292
</tr>
289-
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.isclose.html#array_api_extra.isclose" title="array_api_extra.isclose"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isclose</span></code></a></p></td>
293+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.isclose.html#array_api_extra.isclose" title="array_api_extra.isclose"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isclose</span></code></a></p></td>
290294
<td><p>Return a boolean array where two arrays are element-wise equal within a tolerance.</p></td>
291295
</tr>
292-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.kron.html#array_api_extra.kron" title="array_api_extra.kron"><code class="xref py py-obj docutils literal notranslate"><span class="pre">kron</span></code></a></p></td>
296+
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.kron.html#array_api_extra.kron" title="array_api_extra.kron"><code class="xref py py-obj docutils literal notranslate"><span class="pre">kron</span></code></a></p></td>
293297
<td><p>Kronecker product of two arrays.</p></td>
294298
</tr>
295-
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.nunique.html#array_api_extra.nunique" title="array_api_extra.nunique"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nunique</span></code></a></p></td>
299+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.nunique.html#array_api_extra.nunique" title="array_api_extra.nunique"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nunique</span></code></a></p></td>
296300
<td><p>Count the number of unique elements in an array.</p></td>
297301
</tr>
298-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.pad.html#array_api_extra.pad" title="array_api_extra.pad"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pad</span></code></a></p></td>
302+
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.pad.html#array_api_extra.pad" title="array_api_extra.pad"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pad</span></code></a></p></td>
299303
<td><p>Pad the input array.</p></td>
300304
</tr>
301-
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.setdiff1d.html#array_api_extra.setdiff1d" title="array_api_extra.setdiff1d"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setdiff1d</span></code></a></p></td>
305+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.setdiff1d.html#array_api_extra.setdiff1d" title="array_api_extra.setdiff1d"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setdiff1d</span></code></a></p></td>
302306
<td><p>Find the set difference of two arrays.</p></td>
303307
</tr>
304-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.sinc.html#array_api_extra.sinc" title="array_api_extra.sinc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sinc</span></code></a></p></td>
308+
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.sinc.html#array_api_extra.sinc" title="array_api_extra.sinc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sinc</span></code></a></p></td>
305309
<td><p>Return the normalized sinc function.</p></td>
306310
</tr>
307311
</tbody>

contributing.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@
204204
<li class="toctree-l1 has-children"><a class="reference internal" href="api-reference.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
205205
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.at.html">array_api_extra.at</a></li>
206206
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.atleast_nd.html">array_api_extra.atleast_nd</a></li>
207+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.broadcast_shapes.html">array_api_extra.broadcast_shapes</a></li>
207208
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.cov.html">array_api_extra.cov</a></li>
208209
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.create_diagonal.html">array_api_extra.create_diagonal</a></li>
209210
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.expand_dims.html">array_api_extra.expand_dims</a></li>

contributors.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@
204204
<li class="toctree-l1 has-children"><a class="reference internal" href="api-reference.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
205205
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.at.html">array_api_extra.at</a></li>
206206
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.atleast_nd.html">array_api_extra.atleast_nd</a></li>
207+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.broadcast_shapes.html">array_api_extra.broadcast_shapes</a></li>
207208
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.cov.html">array_api_extra.cov</a></li>
208209
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.create_diagonal.html">array_api_extra.create_diagonal</a></li>
209210
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.expand_dims.html">array_api_extra.expand_dims</a></li>

generated/array_api_extra.at.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@
204204
<li class="toctree-l1 current has-children"><a class="reference internal" href="../api-reference.html">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
205205
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">array_api_extra.at</a></li>
206206
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.atleast_nd.html">array_api_extra.atleast_nd</a></li>
207+
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.broadcast_shapes.html">array_api_extra.broadcast_shapes</a></li>
207208
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.cov.html">array_api_extra.cov</a></li>
208209
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.create_diagonal.html">array_api_extra.create_diagonal</a></li>
209210
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.expand_dims.html">array_api_extra.expand_dims</a></li>

generated/array_api_extra.atleast_nd.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head><meta charset="utf-8"/>
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
6-
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="array_api_extra.cov" href="array_api_extra.cov.html" /><link rel="prev" title="array_api_extra.at" href="array_api_extra.at.html" />
6+
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="array_api_extra.broadcast_shapes" href="array_api_extra.broadcast_shapes.html" /><link rel="prev" title="array_api_extra.at" href="array_api_extra.at.html" />
77

88
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
99
<title>array_api_extra.atleast_nd - array-api-extra 0.6.1.dev0 documentation</title>
@@ -204,6 +204,7 @@
204204
<li class="toctree-l1 current has-children"><a class="reference internal" href="../api-reference.html">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
205205
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.at.html">array_api_extra.at</a></li>
206206
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">array_api_extra.atleast_nd</a></li>
207+
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.broadcast_shapes.html">array_api_extra.broadcast_shapes</a></li>
207208
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.cov.html">array_api_extra.cov</a></li>
208209
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.create_diagonal.html">array_api_extra.create_diagonal</a></li>
209210
<li class="toctree-l2"><a class="reference internal" href="array_api_extra.expand_dims.html">array_api_extra.expand_dims</a></li>
@@ -313,12 +314,12 @@ <h1>array_api_extra.atleast_nd<a class="headerlink" href="#array-api-extra-atlea
313314
<footer>
314315

315316
<div class="related-pages">
316-
<a class="next-page" href="array_api_extra.cov.html">
317+
<a class="next-page" href="array_api_extra.broadcast_shapes.html">
317318
<div class="page-info">
318319
<div class="context">
319320
<span>Next</span>
320321
</div>
321-
<div class="title">array_api_extra.cov</div>
322+
<div class="title">array_api_extra.broadcast_shapes</div>
322323
</div>
323324
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
324325
</a>

0 commit comments

Comments
 (0)