Deploying to gh-pages from @ 5ef0e18 🚀

Author: ev-br

_sources/helper-functions.rst.txt

@@ -52,6 +52,7 @@ yet.
 .. autofunction:: is_pydata_sparse_array
 .. autofunction:: is_ndonnx_array
 .. autofunction:: is_writeable_array
+.. autofunction:: is_lazy_array
 .. autofunction:: is_numpy_namespace
 .. autofunction:: is_cupy_namespace
 .. autofunction:: is_torch_namespace

genindex.html

@@ -287,6 +287,8 @@ <h2>I</h2>
         <li><a href="helper-functions.html#array_api_compat.is_jax_array">is_jax_array() (in module array_api_compat)</a>
 </li>
         <li><a href="helper-functions.html#array_api_compat.is_jax_namespace">is_jax_namespace() (in module array_api_compat)</a>
+</li>
+        <li><a href="helper-functions.html#array_api_compat.is_lazy_array">is_lazy_array() (in module array_api_compat)</a>
 </li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>

helper-functions.html

@@ -510,6 +510,21 @@ <h2>Inspection Helpers<a class="headerlink" href="#inspection-helpers" title="Li
 </div>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="array_api_compat.is_lazy_array">
+<span class="sig-prename descclassname"><span class="pre">array_api_compat.</span></span><span class="sig-name descname"><span class="pre">is_lazy_array</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#array_api_compat.is_lazy_array" title="Link to this definition">¶</a></dt>
+<dd><p>Return True if x is potentially a future or it may be otherwise impossible or
+expensive to eagerly read its contents, regardless of their size, e.g. by
+calling <code class="docutils literal notranslate"><span class="pre">bool(x)</span></code> or <code class="docutils literal notranslate"><span class="pre">float(x)</span></code>.</p>
+<p>Return False otherwise; e.g. <code class="docutils literal notranslate"><span class="pre">bool(x)</span></code> etc. is guaranteed to succeed and to be
+cheap as long as the array has the right dtype and size.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>This function errs on the side of caution for array types that may or may not be
+lazy, e.g. JAX arrays, by always returning True for them.</p>
+</div>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="array_api_compat.is_numpy_namespace">
 <span class="sig-prename descclassname"><span class="pre">array_api_compat.</span></span><span class="sig-name descname"><span class="pre">is_numpy_namespace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xp</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#array_api_compat.is_numpy_namespace" title="Link to this definition">¶</a></dt>
@@ -682,6 +697,7 @@ <h2>Inspection Helpers<a class="headerlink" href="#inspection-helpers" title="Li
 <li><a class="reference internal" href="#array_api_compat.is_pydata_sparse_array"><code class="docutils literal notranslate"><span class="pre">is_pydata_sparse_array()</span></code></a></li>
 <li><a class="reference internal" href="#array_api_compat.is_ndonnx_array"><code class="docutils literal notranslate"><span class="pre">is_ndonnx_array()</span></code></a></li>
 <li><a class="reference internal" href="#array_api_compat.is_writeable_array"><code class="docutils literal notranslate"><span class="pre">is_writeable_array()</span></code></a></li>
+<li><a class="reference internal" href="#array_api_compat.is_lazy_array"><code class="docutils literal notranslate"><span class="pre">is_lazy_array()</span></code></a></li>
 <li><a class="reference internal" href="#array_api_compat.is_numpy_namespace"><code class="docutils literal notranslate"><span class="pre">is_numpy_namespace()</span></code></a></li>
 <li><a class="reference internal" href="#array_api_compat.is_cupy_namespace"><code class="docutils literal notranslate"><span class="pre">is_cupy_namespace()</span></code></a></li>
 <li><a class="reference internal" href="#array_api_compat.is_torch_namespace"><code class="docutils literal notranslate"><span class="pre">is_torch_namespace()</span></code></a></li>