Update generated HTML files [skip ci]

pyxu-org · Aug 23, 2024 · 642dfed · 642dfed
1 parent 0558b4e
commit 642dfed
Show file tree

Hide file tree

Showing 92 changed files with 2,464 additions and 2,455 deletions.
diff --git a/_downloads/09b83b84e67dd3bf3bfa9889ef5464d2/linop-5.pdf b/_downloads/09b83b84e67dd3bf3bfa9889ef5464d2/linop-5.pdf
diff --git a/_downloads/20331cddc327a7a39c725a1390312abd/linop-16_01.pdf b/_downloads/20331cddc327a7a39c725a1390312abd/linop-16_01.pdf
diff --git a/_downloads/22bd9057779cffbbbba3ea842436c066/linop-7_00.pdf b/_downloads/22bd9057779cffbbbba3ea842436c066/linop-7_00.pdf
diff --git a/_downloads/274c9a03963857bb2702dadde78475d6/linop-18_02.pdf b/_downloads/274c9a03963857bb2702dadde78475d6/linop-18_02.pdf
diff --git a/_downloads/2d83951329e9139d2f457f163ef557ff/linop-17_01.pdf b/_downloads/2d83951329e9139d2f457f163ef557ff/linop-17_01.pdf
diff --git a/_downloads/38abfa68484834f661723510290a9594/sampler-1_01_00.pdf b/_downloads/38abfa68484834f661723510290a9594/sampler-1_01_00.pdf
diff --git a/_downloads/3efa35127efc146021b2bb00f30126cc/linop-8_00.pdf b/_downloads/3efa35127efc146021b2bb00f30126cc/linop-8_00.pdf
diff --git a/_downloads/426d2a51889add0a821472e3363e6c86/linop-9_02.pdf b/_downloads/426d2a51889add0a821472e3363e6c86/linop-9_02.pdf
diff --git a/_downloads/46ba4351fee97ccd2e3d0aba89e7413d/linop-14.pdf b/_downloads/46ba4351fee97ccd2e3d0aba89e7413d/linop-14.pdf
diff --git a/_downloads/502950988dae13ff01ed4781361cfe4d/linop-18_03.pdf b/_downloads/502950988dae13ff01ed4781361cfe4d/linop-18_03.pdf
diff --git a/_downloads/5420c90dcdf9b097dbed8ebf47bc7a03/util-2.pdf b/_downloads/5420c90dcdf9b097dbed8ebf47bc7a03/util-2.pdf
diff --git a/_downloads/5b19c3c62ae35eb4489c976153e230f2/linop-9_00.pdf b/_downloads/5b19c3c62ae35eb4489c976153e230f2/linop-9_00.pdf
diff --git a/_downloads/5be70851f96b004b61b84e14faba6d02/util-1.pdf b/_downloads/5be70851f96b004b61b84e14faba6d02/util-1.pdf
diff --git a/_downloads/5d831190e971237b56d4c6f5001a1497/linop-1.pdf b/_downloads/5d831190e971237b56d4c6f5001a1497/linop-1.pdf
diff --git a/_downloads/5ebda40b456c165df2ad890040597b6f/linop-15.pdf b/_downloads/5ebda40b456c165df2ad890040597b6f/linop-15.pdf
diff --git a/_downloads/5f2c7960744f306a7f67e6f866544db8/abc-1.pdf b/_downloads/5f2c7960744f306a7f67e6f866544db8/abc-1.pdf
diff --git a/_downloads/612022bbeb60e12bbedb2442f5e9eb14/linop-8_01.pdf b/_downloads/612022bbeb60e12bbedb2442f5e9eb14/linop-8_01.pdf
diff --git a/_downloads/6f030212e1ed44374360d96af1b8bb08/sampler-1_01_00.png b/_downloads/6f030212e1ed44374360d96af1b8bb08/sampler-1_01_00.png
diff --git a/_downloads/720322c27d60e8bdfe2e26d9c52e0397/linop-11.pdf b/_downloads/720322c27d60e8bdfe2e26d9c52e0397/linop-11.pdf
diff --git a/_downloads/76756524613d2983ea3587d04687c2c6/linop-7_01.pdf b/_downloads/76756524613d2983ea3587d04687c2c6/linop-7_01.pdf
diff --git a/_downloads/7bf4f564a15100201d0a1e7baafafa52/opt-solver-2.pdf b/_downloads/7bf4f564a15100201d0a1e7baafafa52/opt-solver-2.pdf
diff --git a/_downloads/7cceec4a3abf2947afcf0fbf1a95fbc2/linop-9_01.pdf b/_downloads/7cceec4a3abf2947afcf0fbf1a95fbc2/linop-9_01.pdf
diff --git a/_downloads/7f5f34fa22392f9857f5e4557ab603eb/linop-18_01.pdf b/_downloads/7f5f34fa22392f9857f5e4557ab603eb/linop-18_01.pdf
diff --git a/_downloads/8149e23614b7c5de54fdf55f5a7a75c5/linop-17_00.pdf b/_downloads/8149e23614b7c5de54fdf55f5a7a75c5/linop-17_00.pdf
diff --git a/_downloads/8186afc1cad5ba418c82646f4dc4c85a/sampler-1_00_00.pdf b/_downloads/8186afc1cad5ba418c82646f4dc4c85a/sampler-1_00_00.pdf
diff --git a/_downloads/82d6d7024b395a55bfdcd60ed84361df/linop-16_02.pdf b/_downloads/82d6d7024b395a55bfdcd60ed84361df/linop-16_02.pdf
diff --git a/_downloads/852396df1c2a68b4ab13ea440094a13b/linop-2.pdf b/_downloads/852396df1c2a68b4ab13ea440094a13b/linop-2.pdf
diff --git a/_downloads/88a3f16ef7fce8fdb35fd4edf3b6ace4/sampler-1_00_00.png b/_downloads/88a3f16ef7fce8fdb35fd4edf3b6ace4/sampler-1_00_00.png
diff --git a/_downloads/9c4ebc29020e065ee3bc3d0953afc0cb/sampler-1_01_00.hires.png b/_downloads/9c4ebc29020e065ee3bc3d0953afc0cb/sampler-1_01_00.hires.png
diff --git a/_downloads/9eaea73fdea624e0206631a1d44ed0c6/linop-7_03.pdf b/_downloads/9eaea73fdea624e0206631a1d44ed0c6/linop-7_03.pdf
diff --git a/_downloads/b2643be9761ce6a5244d11d98408529f/linop-13.pdf b/_downloads/b2643be9761ce6a5244d11d98408529f/linop-13.pdf
diff --git a/_downloads/b793257364ec7e73fe09d6ac0cf897bb/linop-3.pdf b/_downloads/b793257364ec7e73fe09d6ac0cf897bb/linop-3.pdf
diff --git a/_downloads/c0190b5d57d3d151adb5651d8b8a1ee5/linop-10.pdf b/_downloads/c0190b5d57d3d151adb5651d8b8a1ee5/linop-10.pdf
diff --git a/_downloads/c604d2df9d37527a80c0dc91b76cf5db/sampler-1_00_00.hires.png b/_downloads/c604d2df9d37527a80c0dc91b76cf5db/sampler-1_00_00.hires.png
diff --git a/_downloads/ce02986c52568fc946d170be6555d837/linop-18_00.pdf b/_downloads/ce02986c52568fc946d170be6555d837/linop-18_00.pdf
diff --git a/_downloads/d722bee71da109d7780d99550eacebb8/linop-16_00.pdf b/_downloads/d722bee71da109d7780d99550eacebb8/linop-16_00.pdf
diff --git a/_downloads/db9ac5fbbfe21a45f644cc919f758da2/opt-solver-1.pdf b/_downloads/db9ac5fbbfe21a45f644cc919f758da2/opt-solver-1.pdf
diff --git a/_downloads/e8cf3ce50f34b6ff0831d06aeebabca8/linop-6.pdf b/_downloads/e8cf3ce50f34b6ff0831d06aeebabca8/linop-6.pdf
diff --git a/_downloads/ef375de8a555744bde8d66d2be4d2ecd/linop-4.pdf b/_downloads/ef375de8a555744bde8d66d2be4d2ecd/linop-4.pdf
diff --git a/_downloads/f8ee9bb8e004715b22514fc6afbb3a71/linop-7_02.pdf b/_downloads/f8ee9bb8e004715b22514fc6afbb3a71/linop-7_02.pdf
diff --git a/_images/sampler-1_00_00.png b/_images/sampler-1_00_00.png
diff --git a/_images/sampler-1_01_00.png b/_images/sampler-1_01_00.png
diff --git a/_modules/typing.html b/_modules/typing.html
diff --git a/_parse_plugins/plugins.db b/_parse_plugins/plugins.db
diff --git a/api/abc.html b/api/abc.html
@@ -1789,7 +1789,7 @@ <h2><a class="toc-backref" href="#id10" role="doc-backlink">pyxu.abc.operator</a
 <li><p><strong>k</strong> (<a class="reference internal" href="info.ptype.html#pyxu.info.ptype.Integer" title="pyxu.info.ptype.Integer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Integer</span></code></a>) – Number of singular values to compute.</p></li>
 <li><p><strong>gpu</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – If <code class="docutils literal notranslate"><span class="pre">True</span></code> the singular value decomposition is performed on the GPU.</p></li>
 <li><p><strong>dtype</strong> (<a class="reference internal" href="info.ptype.html#pyxu.info.ptype.DType" title="pyxu.info.ptype.DType"><code class="xref py py-class docutils literal notranslate"><span class="pre">DType</span></code></a>) – Working precision of the linear operator.</p></li>
-<li><p><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code></a>) – Additional kwargs accepted by <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.svds.html#scipy.sparse.linalg.svds" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">svds()</span></code></a>.</p></li>
+<li><p><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code></a>) – Additional kwargs accepted by <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.svds.html#scipy.sparse.linalg.svds" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">svds()</span></code></a>.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>

diff --git a/api/index.html b/api/index.html
@@ -873,7 +873,7 @@ <h3><a class="toc-backref" href="#id16" role="doc-backlink">SciPy</a><a class="h
 <table class="autosummary longtable table autosummary">
 <tbody>
 <tr class="row-odd"><td><p><a class="reference internal" href="operator.interop.html#pyxu.operator.interop.from_sciop" title="pyxu.operator.interop.from_sciop"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_sciop</span></code></a>(cls, sp_op)</p></td>
-<td><p>Wrap a <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.LinearOperator.html#scipy.sparse.linalg.LinearOperator" title="(in SciPy v1.14.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinearOperator</span></code></a> as a 2D <a class="reference internal" href="abc.html#pyxu.abc.LinOp" title="pyxu.abc.LinOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinOp</span></code></a> (or sub-class thereof).</p></td>
+<td><p>Wrap a <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.LinearOperator.html#scipy.sparse.linalg.LinearOperator" title="(in SciPy v1.14.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinearOperator</span></code></a> as a 2D <a class="reference internal" href="abc.html#pyxu.abc.LinOp" title="pyxu.abc.LinOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinOp</span></code></a> (or sub-class thereof).</p></td>
 </tr>
 </tbody>
 </table>

diff --git a/api/info.deps.html b/api/info.deps.html
@@ -644,7 +644,7 @@
 <dd><p>Python module associated to an array backend.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>linalg</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – Return the linear-algebra submodule with identical API to <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/sparse.linalg.html#module-scipy.sparse.linalg" title="(in SciPy v1.14.0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">scipy.sparse.linalg</span></code></a>.</p>
+<dd class="field-odd"><p><strong>linalg</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – Return the linear-algebra submodule with identical API to <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/sparse.linalg.html#module-scipy.sparse.linalg" title="(in SciPy v1.14.1)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">scipy.sparse.linalg</span></code></a>.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/types.html#types.ModuleType" title="(in Python v3.12)"><em>ModuleType</em></a></p>

diff --git a/api/operator.interop.html b/api/operator.interop.html
@@ -604,11 +604,11 @@ <h2><a class="toc-backref" href="#id4" role="doc-backlink">SciPy</a><a class="he
 <dl class="py function">
 <dt class="sig sig-object py" id="pyxu.operator.interop.from_sciop">
 <span class="sig-name descname"><span class="pre">from_sciop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sp_op</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/pyxu/operator/interop/sciop.html#from_sciop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyxu.operator.interop.from_sciop" title="Link to this definition">#</a></dt>
-<dd><p>Wrap a <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.LinearOperator.html#scipy.sparse.linalg.LinearOperator" title="(in SciPy v1.14.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinearOperator</span></code></a> as a 2D <a class="reference internal" href="abc.html#pyxu.abc.LinOp" title="pyxu.abc.LinOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinOp</span></code></a> (or sub-class thereof).</p>
+<dd><p>Wrap a <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.LinearOperator.html#scipy.sparse.linalg.LinearOperator" title="(in SciPy v1.14.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinearOperator</span></code></a> as a 2D <a class="reference internal" href="abc.html#pyxu.abc.LinOp" title="pyxu.abc.LinOp"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinOp</span></code></a> (or sub-class thereof).</p>
 <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>sp_op</strong> (<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.LinearOperator.html#scipy.sparse.linalg.LinearOperator" title="(in SciPy v1.14.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinearOperator</span></code></a>) – (N, M) Linear CPU/GPU operator compliant with SciPy’s interface.</p></li>
+<li><p><strong>sp_op</strong> (<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.LinearOperator.html#scipy.sparse.linalg.LinearOperator" title="(in SciPy v1.14.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinearOperator</span></code></a>) – (N, M) Linear CPU/GPU operator compliant with SciPy’s interface.</p></li>
 <li><p><strong>cls</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Type" title="(in Python v3.12)"><em>Type</em></a><em>[</em><a class="reference internal" href="info.ptype.html#pyxu.info.ptype.OpT" title="pyxu.info.ptype.OpT"><em>OpT</em></a><em>]</em>)</p></li>
 </ul>
 </dd>

diff --git a/api/operator/linop.html b/api/operator/linop.html
@@ -941,8 +941,8 @@ <h2><a class="toc-backref" href="#id32" role="doc-backlink">Transforms</a><a cla
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>dim_shape</strong> (<a class="reference internal" href="../info.ptype.html#pyxu.info.ptype.NDArrayShape" title="pyxu.info.ptype.NDArrayShape"><code class="xref py py-class docutils literal notranslate"><span class="pre">NDArrayShape</span></code></a>) – (M1,…,MD) dimensions of the input <span class="math notranslate nohighlight">\(\mathbf{x} \in \mathbb{C}^{M_{1} \times\cdots\times M_{D}}\)</span>.</p></li>
 <li><p><strong>axes</strong> (<a class="reference internal" href="../info.ptype.html#pyxu.info.ptype.NDArrayAxis" title="pyxu.info.ptype.NDArrayAxis"><code class="xref py py-class docutils literal notranslate"><span class="pre">NDArrayAxis</span></code></a>) – Axes over which to compute the FFT. If not given, all axes are used.</p></li>
-<li><p><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>) – <p>Extra kwargs passed to <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.fft.fftn.html#scipy.fft.fftn" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.fft.fftn()</span></code></a> or <a class="reference external" href="https://docs.cupy.dev/en/latest/reference/generated/cupyx.scipy.fft.fftn.html#cupyx.scipy.fft.fftn" title="(in CuPy v14.0.0a1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">cupyx.scipy.fft.fftn()</span></code></a>.</p>
-<p>Supported parameters for <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.fft.fftn.html#scipy.fft.fftn" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.fft.fftn()</span></code></a> are:</p>
+<li><p><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>) – <p>Extra kwargs passed to <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.fft.fftn.html#scipy.fft.fftn" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.fft.fftn()</span></code></a> or <a class="reference external" href="https://docs.cupy.dev/en/latest/reference/generated/cupyx.scipy.fft.fftn.html#cupyx.scipy.fft.fftn" title="(in CuPy v14.0.0a1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">cupyx.scipy.fft.fftn()</span></code></a>.</p>
+<p>Supported parameters for <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.fft.fftn.html#scipy.fft.fftn" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">scipy.fft.fftn()</span></code></a> are:</p>
 <blockquote>
 <div><ul>
 <li><p>workers: int = None</p></li>

diff --git a/api/operator/map.html b/api/operator/map.html
@@ -2390,7 +2390,7 @@ <h2><a class="toc-backref" href="#id2" role="doc-backlink">Misc</a><a class="hea
 <li><p><strong>k</strong> (<a class="reference internal" href="../info.ptype.html#pyxu.info.ptype.Integer" title="pyxu.info.ptype.Integer"><code class="xref py py-class docutils literal notranslate"><span class="pre">Integer</span></code></a>) – Number of singular values to compute.</p></li>
 <li><p><strong>gpu</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – If <code class="docutils literal notranslate"><span class="pre">True</span></code> the singular value decomposition is performed on the GPU.</p></li>
 <li><p><strong>dtype</strong> (<a class="reference internal" href="../info.ptype.html#pyxu.info.ptype.DType" title="pyxu.info.ptype.DType"><code class="xref py py-class docutils literal notranslate"><span class="pre">DType</span></code></a>) – Working precision of the linear operator.</p></li>
-<li><p><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code></a>) – Additional kwargs accepted by <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.svds.html#scipy.sparse.linalg.svds" title="(in SciPy v1.14.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">svds()</span></code></a>.</p></li>
+<li><p><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code></a>) – Additional kwargs accepted by <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.linalg.svds.html#scipy.sparse.linalg.svds" title="(in SciPy v1.14.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">svds()</span></code></a>.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>