Skip to content

Commit

Permalink
Deploying to gh-pages from @ 11f76bf 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
CosmoMatt committed Oct 11, 2024
1 parent e4b878d commit f1e9e64
Show file tree
Hide file tree
Showing 10 changed files with 86 additions and 21 deletions.
5 changes: 5 additions & 0 deletions _sources/api/precompute_transforms/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ Precompute Functions
- Builds a kernel including quadrature weights and Wigner-D coefficients for spherical harmonic transform.
* - :func:`~s2fft.precompute_transforms.construct.wigner_kernel`
- Builds a kernel including quadrature weights and Wigner-D coefficients for Wigner transform.
* - :func:`~s2fft.precompute_transforms.construct.spin_spherical_kernel_jax`
- Builds a kernel including quadrature weights and Wigner-D coefficients for spherical harmonic transform (JAX).
* - :func:`~s2fft.precompute_transforms.construct.wigner_kernel_jax`
- Builds a kernel including quadrature weights and Wigner-D coefficients for Wigner transform (JAX).
* - :func:`~s2fft.precompute_transforms.construct.healpix_phase_shifts`
- Builds a vector of corresponding phase shifts for each HEALPix latitudinal ring.

Expand All @@ -69,6 +73,7 @@ Precompute Functions
:caption: Precompute Transforms

construct
alt_construct
spin_spherical
wigner

52 changes: 34 additions & 18 deletions api/precompute_transforms/construct.html

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions api/precompute_transforms/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -647,6 +647,12 @@ <h1>Precompute Functions<a class="headerlink" href="#precompute-functions" title
<tr class="row-odd"><td><p><a class="reference internal" href="construct.html#s2fft.precompute_transforms.construct.wigner_kernel" title="s2fft.precompute_transforms.construct.wigner_kernel"><code class="xref py py-func docutils literal notranslate"><span class="pre">wigner_kernel()</span></code></a></p></td>
<td><p>Builds a kernel including quadrature weights and Wigner-D coefficients for Wigner transform.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="construct.html#s2fft.precompute_transforms.construct.spin_spherical_kernel_jax" title="s2fft.precompute_transforms.construct.spin_spherical_kernel_jax"><code class="xref py py-func docutils literal notranslate"><span class="pre">spin_spherical_kernel_jax()</span></code></a></p></td>
<td><p>Builds a kernel including quadrature weights and Wigner-D coefficients for spherical harmonic transform (JAX).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="construct.html#s2fft.precompute_transforms.construct.wigner_kernel_jax" title="s2fft.precompute_transforms.construct.wigner_kernel_jax"><code class="xref py py-func docutils literal notranslate"><span class="pre">wigner_kernel_jax()</span></code></a></p></td>
<td><p>Builds a kernel including quadrature weights and Wigner-D coefficients for Wigner transform (JAX).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="construct.html#s2fft.precompute_transforms.construct.healpix_phase_shifts" title="s2fft.precompute_transforms.construct.healpix_phase_shifts"><code class="xref py py-func docutils literal notranslate"><span class="pre">healpix_phase_shifts()</span></code></a></p></td>
<td><p>Builds a vector of corresponding phase shifts for each HEALPix latitudinal ring.</p></td>
</tr>
Expand Down
33 changes: 33 additions & 0 deletions api/recursions/risbo.html
Original file line number Diff line number Diff line change
Expand Up @@ -580,6 +580,39 @@
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="s2fft.recursions.risbo.compute_full_vectorised">
<span class="sig-prename descclassname"><span class="pre">s2fft.recursions.risbo.</span></span><span class="sig-name descname"><span class="pre">compute_full_vectorised</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">beta</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">L</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">el</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">ndarray</span></span></span><a class="headerlink" href="#s2fft.recursions.risbo.compute_full_vectorised" title="Link to this definition">#</a></dt>
<dd><p>Compute Wigner-d at all arguments <span class="math notranslate nohighlight">\(\beta\)</span> for full plane using
Risbo recursion.</p>
<p>The Wigner-d plane is computed by recursion over <span class="math notranslate nohighlight">\(\ell\)</span>.
Thus, for <span class="math notranslate nohighlight">\(\ell &gt; 0\)</span> the plane must be computed already for
<span class="math notranslate nohighlight">\(\ell - 1\)</span>. At present, for <span class="math notranslate nohighlight">\(\ell = 0\)</span> the recusion is initialised.</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>dl</strong> (<em>np.ndarray</em>) – Wigner-d plane for <span class="math notranslate nohighlight">\(\ell - 1\)</span> and for all <span class="math notranslate nohighlight">\(\beta\)</span>.</p></li>
<li><p><strong>beta</strong> (<em>np.ndarray</em>) – Arguments <span class="math notranslate nohighlight">\(\beta\)</span> at which to compute Wigner-d plane.</p></li>
<li><p><strong>L</strong> (<em>int</em>) – Harmonic band-limit.</p></li>
<li><p><strong>el</strong> (<em>int</em>) – Spherical harmonic degree <span class="math notranslate nohighlight">\(\ell\)</span>.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="simple">
<dt>Plane of Wigner-d for <span class="math notranslate nohighlight">\(\ell\)</span> and all angles <span class="math notranslate nohighlight">\(\beta\)</span>,</dt><dd><p>with full plane computed.</p>
</dd>
</dl>
</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>np.ndarray</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This function is an implementation of the risbo recursion vectorised to explicitly
evaluate the recursion for all betas simultaneously.</p>
</dd></dl>

</section>


Expand Down
4 changes: 2 additions & 2 deletions api/recursions/risbo_jax.html
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@
<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>dl</strong> (<em>np.ndarray</em>) – Wigner-d plane for <span class="math notranslate nohighlight">\(\ell - 1\)</span> at <span class="math notranslate nohighlight">\(\beta\)</span>.</p></li>
<li><p><strong>dl</strong> (<em>jnp.ndarray</em>) – Wigner-d plane for <span class="math notranslate nohighlight">\(\ell - 1\)</span> at <span class="math notranslate nohighlight">\(\beta\)</span>.</p></li>
<li><p><strong>beta</strong> (<em>float</em>) – Argument <span class="math notranslate nohighlight">\(\beta\)</span> at which to compute Wigner-d plane.</p></li>
<li><p><strong>L</strong> (<em>int</em>) – Harmonic band-limit.</p></li>
<li><p><strong>el</strong> (<em>int</em>) – Spherical harmonic degree <span class="math notranslate nohighlight">\(\ell\)</span>.</p></li>
Expand All @@ -516,7 +516,7 @@
<dd class="field-even"><p>Plane of Wigner-d for <cite>el</cite> and <cite>beta</cite>, with full plane computed.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>np.ndarray</p>
<dd class="field-odd"><p>jnp.ndarray</p>
</dd>
</dl>
</dd></dl>
Expand Down
3 changes: 3 additions & 0 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/tabs.js?v=3030b3cb"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'genindex';</script>
<link rel="index" title="Index" href="#" />
Expand Down Expand Up @@ -512,6 +513,8 @@ <h2 id="C">C</h2>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/recursions/risbo.html#s2fft.recursions.risbo.compute_full_vectorised">compute_full_vectorised() (in module s2fft.recursions.risbo)</a>
</li>
<li><a href="api/recursions/trapani.html#s2fft.recursions.trapani.compute_full_vectorized">compute_full_vectorized() (in module s2fft.recursions.trapani)</a>
</li>
<li><a href="api/recursions/trapani.html#s2fft.recursions.trapani.compute_quarter">compute_quarter() (in module s2fft.recursions.trapani)</a>
Expand Down
Binary file modified objects.inv
Binary file not shown.
1 change: 1 addition & 0 deletions py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/tabs.js?v=3030b3cb"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'py-modindex';</script>
<link rel="index" title="Index" href="genindex.html" />
Expand Down
1 change: 1 addition & 0 deletions search.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/tabs.js?v=3030b3cb"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'search';</script>
<script src="_static/searchtools.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit f1e9e64

Please sign in to comment.