Skip to content

Commit 56686fa

Browse files
committed
Deploying to gh-pages from @ f74d71a 🚀
1 parent b80b9df commit 56686fa

26 files changed

+462
-20
lines changed

_sources/api-reference.md.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
:nosignatures:
77
:toctree: generated
88

9+
apply_where
910
at
1011
atleast_nd
1112
broadcast_shapes
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
array\_api\_extra.apply\_where
2+
==============================
3+
4+
.. currentmodule:: array_api_extra
5+
6+
.. autofunction:: apply_where

api-reference.html

Lines changed: 19 additions & 15 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.at" href="generated/array_api_extra.at.html" /><link rel="prev" title="array-api-extra" href="index.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.apply_where" href="generated/array_api_extra.apply_where.html" /><link rel="prev" title="array-api-extra" href="index.html" />
77

88
<!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 -->
99
<title>API Reference - array-api-extra 0.7.0.dev0 documentation</title>
@@ -202,6 +202,7 @@
202202
<ul class="current">
203203
<li class="toctree-l1"><a class="reference internal" href="index.html">array-api-extra</a></li>
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>
205+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.apply_where.html">array_api_extra.apply_where</a></li>
205206
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.at.html">array_api_extra.at</a></li>
206207
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.atleast_nd.html">array_api_extra.atleast_nd</a></li>
207208
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.broadcast_shapes.html">array_api_extra.broadcast_shapes</a></li>
@@ -272,40 +273,43 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
272273
<div class="table-wrapper autosummary longtable docutils container">
273274
<table class="autosummary longtable docutils align-default">
274275
<tbody>
275-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.at.html#array_api_extra.at" title="array_api_extra.at"><code class="xref py py-obj docutils literal notranslate"><span class="pre">at</span></code></a></p></td>
276+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/array_api_extra.apply_where.html#array_api_extra.apply_where" title="array_api_extra.apply_where"><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply_where</span></code></a></p></td>
277+
<td><p>Run one of two elementwise functions depending on a condition.</p></td>
278+
</tr>
279+
<tr class="row-even"><td><p><a class="reference internal" href="generated/array_api_extra.at.html#array_api_extra.at" title="array_api_extra.at"><code class="xref py py-obj docutils literal notranslate"><span class="pre">at</span></code></a></p></td>
276280
<td><p>Update operations for read-only arrays.</p></td>
277281
</tr>
278-
<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>
282+
<tr class="row-odd"><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>
279283
<td><p>Recursively expand the dimension of an array to at least <cite>ndim</cite>.</p></td>
280284
</tr>
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>
285+
<tr class="row-even"><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>
282286
<td><p>Compute the shape of the broadcasted arrays.</p></td>
283287
</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>
288+
<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>
285289
<td><p>Estimate a covariance matrix.</p></td>
286290
</tr>
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>
291+
<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>
288292
<td><p>Construct a diagonal array.</p></td>
289293
</tr>
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>
294+
<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>
291295
<td><p>Expand the shape of an array.</p></td>
292296
</tr>
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>
297+
<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>
294298
<td><p>Return a boolean array where two arrays are element-wise equal within a tolerance.</p></td>
295299
</tr>
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>
300+
<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>
297301
<td><p>Kronecker product of two arrays.</p></td>
298302
</tr>
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>
303+
<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>
300304
<td><p>Count the number of unique elements in an array.</p></td>
301305
</tr>
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>
306+
<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>
303307
<td><p>Pad the input array.</p></td>
304308
</tr>
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>
309+
<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>
306310
<td><p>Find the set difference of two arrays.</p></td>
307311
</tr>
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>
312+
<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>
309313
<td><p>Return the normalized sinc function.</p></td>
310314
</tr>
311315
</tbody>
@@ -318,12 +322,12 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this
318322
<footer>
319323

320324
<div class="related-pages">
321-
<a class="next-page" href="generated/array_api_extra.at.html">
325+
<a class="next-page" href="generated/array_api_extra.apply_where.html">
322326
<div class="page-info">
323327
<div class="context">
324328
<span>Next</span>
325329
</div>
326-
<div class="title">array_api_extra.at</div>
330+
<div class="title">array_api_extra.apply_where</div>
327331
</div>
328332
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
329333
</a>

contributing.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@
202202
<ul class="current">
203203
<li class="toctree-l1"><a class="reference internal" href="index.html">array-api-extra</a></li>
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>
205+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.apply_where.html">array_api_extra.apply_where</a></li>
205206
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.at.html">array_api_extra.at</a></li>
206207
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.atleast_nd.html">array_api_extra.atleast_nd</a></li>
207208
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.broadcast_shapes.html">array_api_extra.broadcast_shapes</a></li>

contributors.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@
202202
<ul class="current">
203203
<li class="toctree-l1"><a class="reference internal" href="index.html">array-api-extra</a></li>
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>
205+
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.apply_where.html">array_api_extra.apply_where</a></li>
205206
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.at.html">array_api_extra.at</a></li>
206207
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.atleast_nd.html">array_api_extra.atleast_nd</a></li>
207208
<li class="toctree-l2"><a class="reference internal" href="generated/array_api_extra.broadcast_shapes.html">array_api_extra.broadcast_shapes</a></li>

0 commit comments

Comments
 (0)