Skip to content

Commit 4172d89

Browse files
committed
Deploying to gh-pages from @ 1bc0282 🚀
1 parent 77c02af commit 4172d89

3 files changed

Lines changed: 3 additions & 19 deletions

File tree

generated/array_api_extra.apply_where.html

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -321,14 +321,6 @@ <h1>apply_where<a class="headerlink" href="#apply-where" title="Link to this hea
321321
<dt class="sig sig-object py" id="array_api_extra.apply_where">
322322
<span class="sig-prename descclassname"><span class="pre">array_api_extra.</span></span><span class="sig-name descname"><span class="pre">apply_where</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cond</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">f2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="positional-only-separator o"><abbr title="Positional-only parameter separator (PEP 570)"><span class="pre">/</span></abbr></span></em>, <em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">fill_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kwargs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#array_api_extra.apply_where" title="Link to this definition"></a></dt>
323323
<dd><p>Run one of two elementwise functions depending on a condition.</p>
324-
<dl class="field-list simple">
325-
<dt class="field-odd">Overloads<span class="colon">:</span></dt>
326-
<dd class="field-odd"><ul class="simple">
327-
<li><p><strong>cond</strong> (<span class="sphinx_autodoc_typehints-type">Array</span>), <strong>args</strong> (<span class="sphinx_autodoc_typehints-type">Array | tuple[Array, …]</span>), <strong>f1</strong> (<span class="sphinx_autodoc_typehints-type">Callable[…, Array]</span>), <strong>f2</strong> (<span class="sphinx_autodoc_typehints-type">Callable[…, Array]</span>), <strong>kwargs</strong> (<span class="sphinx_autodoc_typehints-type">dict[str, Array] | None</span>), <strong>xp</strong> (<span class="sphinx_autodoc_typehints-type">ArrayNamespace | None</span>) → <span class="sphinx_autodoc_typehints-type">Array</span></p></li>
328-
<li><p><strong>cond</strong> (<span class="sphinx_autodoc_typehints-type">Array</span>), <strong>args</strong> (<span class="sphinx_autodoc_typehints-type">Array | tuple[Array, …]</span>), <strong>f1</strong> (<span class="sphinx_autodoc_typehints-type">Callable[…, Array]</span>), <strong>fill_value</strong> (<span class="sphinx_autodoc_typehints-type">Array | complex</span>), <strong>kwargs</strong> (<span class="sphinx_autodoc_typehints-type">dict[str, Array] | None</span>), <strong>xp</strong> (<span class="sphinx_autodoc_typehints-type">ArrayNamespace | None</span>) → <span class="sphinx_autodoc_typehints-type">Array</span></p></li>
329-
</ul>
330-
</dd>
331-
</dl>
332324
<p>Equivalent to <code class="docutils literal notranslate"><span class="pre">f1(*args)</span> <span class="pre">if</span> <span class="pre">cond</span> <span class="pre">else</span> <span class="pre">fill_value</span></code> performed elementwise
333325
when <cite>fill_value</cite> is defined, otherwise to <code class="docutils literal notranslate"><span class="pre">f1(*args)</span> <span class="pre">if</span> <span class="pre">cond</span> <span class="pre">else</span> <span class="pre">f2(*args)</span></code>.</p>
334326
<dl class="field-list simple">
@@ -357,7 +349,7 @@ <h1>apply_where<a class="headerlink" href="#apply-where" title="Link to this hea
357349
either <cite>fill_value</cite> or the output of <cite>f2</cite>.</p>
358350
</dd>
359351
<dt class="field-odd">Return type<span class="colon">:</span></dt>
360-
<dd class="field-odd"><p>Array</p>
352+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></span></p>
361353
</dd>
362354
</dl>
363355
<p class="rubric">Notes</p>

generated/array_api_extra.lazy_apply.html

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -321,14 +321,6 @@ <h1>lazy_apply<a class="headerlink" href="#lazy-apply" title="Link to this headi
321321
<dt class="sig sig-object py" id="array_api_extra.lazy_apply">
322322
<span class="sig-prename descclassname"><span class="pre">array_api_extra.</span></span><span class="sig-name descname"><span class="pre">lazy_apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_numpy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#array_api_extra.lazy_apply" title="Link to this definition"></a></dt>
323323
<dd><p>Lazily apply an eager function.</p>
324-
<dl class="field-list simple">
325-
<dt class="field-odd">Overloads<span class="colon">:</span></dt>
326-
<dd class="field-odd"><ul class="simple">
327-
<li><p><strong>func</strong> (<span class="sphinx_autodoc_typehints-type">Callable[P, Array | ArrayLike]</span>), <strong>args</strong> (<span class="sphinx_autodoc_typehints-type">Array | complex | None</span>), <strong>shape</strong> (<span class="sphinx_autodoc_typehints-type">tuple[int | None, …] | None</span>), <strong>dtype</strong> (<span class="sphinx_autodoc_typehints-type">DType | None</span>), <strong>as_numpy</strong> (<span class="sphinx_autodoc_typehints-type">bool</span>), <strong>xp</strong> (<span class="sphinx_autodoc_typehints-type">ArrayNamespace | None</span>), <strong>kwargs</strong> (<span class="sphinx_autodoc_typehints-type">P.kwargs</span>) → <span class="sphinx_autodoc_typehints-type">Array</span></p></li>
328-
<li><p><strong>func</strong> (<span class="sphinx_autodoc_typehints-type">Callable[P, Sequence[Array | ArrayLike]]</span>), <strong>args</strong> (<span class="sphinx_autodoc_typehints-type">Array | complex | None</span>), <strong>shape</strong> (<span class="sphinx_autodoc_typehints-type">Sequence[tuple[int | None, …]]</span>), <strong>dtype</strong> (<span class="sphinx_autodoc_typehints-type">Sequence[DType] | None</span>), <strong>as_numpy</strong> (<span class="sphinx_autodoc_typehints-type">bool</span>), <strong>xp</strong> (<span class="sphinx_autodoc_typehints-type">ArrayNamespace | None</span>), <strong>kwargs</strong> (<span class="sphinx_autodoc_typehints-type">P.kwargs</span>) → <span class="sphinx_autodoc_typehints-type">tuple[Array, …]</span></p></li>
329-
</ul>
330-
</dd>
331-
</dl>
332324
<p>If the backend of the input arrays is lazy, e.g. Dask or jitted JAX, the execution
333325
of the function is delayed until the graph is materialized; if it’s eager, the
334326
function is executed immediately.</p>
@@ -372,7 +364,7 @@ <h1>lazy_apply<a class="headerlink" href="#lazy-apply" title="Link to this headi
372364
Otherwise, return a tuple of arrays.</p>
373365
</dd>
374366
<dt class="field-odd">Return type<span class="colon">:</span></dt>
375-
<dd class="field-odd"><p>Array | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)">tuple</a>[Array, …]</p>
367+
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#Ellipsis" title="(in Python v3.14)"><code class="xref py py-data docutils literal notranslate"><span class="pre">...</span></code></a>]</span></p>
376368
</dd>
377369
</dl>
378370
<p class="rubric">Notes</p>

0 commit comments

Comments
 (0)