Skip to content

Commit bea24db

Browse files
split fast transforms & plans in docs
1 parent 4ec799a commit bea24db

File tree

2 files changed

+32
-24
lines changed

2 files changed

+32
-24
lines changed

docs/src/index.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -25,95 +25,99 @@ cheb2leg
2525
```
2626

2727
```@docs
28-
plan_leg2cheb
28+
cjt
2929
```
3030

3131
```@docs
32-
plan_cheb2leg
32+
icjt
3333
```
3434

3535
```@docs
36-
cjt
36+
jjt
3737
```
3838

3939
```@docs
40-
icjt
40+
nufft1
4141
```
4242

4343
```@docs
44-
jjt
44+
nufft2
4545
```
4646

4747
```@docs
48-
plan_cjt
48+
nufft3
4949
```
5050

5151
```@docs
52-
plan_icjt
52+
inufft1
5353
```
5454

5555
```@docs
56-
nufft1
56+
inufft2
5757
```
5858

5959
```@docs
60-
nufft2
60+
paduatransform
6161
```
6262

6363
```@docs
64-
nufft3
64+
ipaduatransform
6565
```
6666

6767
```@docs
68-
inufft1
68+
sph2fourier
6969
```
7070

7171
```@docs
72-
inufft2
72+
fourier2sph
7373
```
7474

75+
## Planning The Fast Transforms
76+
77+
Most transforms have separate forward and inverse plans. In some instances, however, the inverse is in the sense of least-squares, and therefore only the forward transform is planned.
78+
7579
```@docs
76-
plan_nufft1
80+
plan_leg2cheb
7781
```
7882

7983
```@docs
80-
plan_nufft2
84+
plan_cheb2leg
8185
```
8286

8387
```@docs
84-
plan_nufft3
88+
plan_cjt
8589
```
8690

8791
```@docs
88-
plan_inufft1
92+
plan_icjt
8993
```
9094

9195
```@docs
92-
plan_inufft2
96+
plan_nufft1
9397
```
9498

9599
```@docs
96-
paduatransform
100+
plan_nufft2
97101
```
98102

99103
```@docs
100-
ipaduatransform
104+
plan_nufft3
101105
```
102106

103107
```@docs
104-
plan_paduatransform!
108+
plan_inufft1
105109
```
106110

107111
```@docs
108-
plan_ipaduatransform!
112+
plan_inufft2
109113
```
110114

111115
```@docs
112-
sph2fourier
116+
plan_paduatransform!
113117
```
114118

115119
```@docs
116-
fourier2sph
120+
plan_ipaduatransform!
117121
```
118122

119123
```@docs

src/SphericalHarmonics/sphfunctions.jl

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,11 @@ function maxcolnorm(A::AbstractMatrix)
8383
end
8484

8585
doc"""
86-
Pointwise evaluation of spherical harmonic ``Y_{\ell}^m(\theta,\varphi)``.
86+
Pointwise evaluation of spherical harmonic:
87+
88+
```math
89+
Y_\ell^m(\theta,\varphi) = \frac{e^{{\rm i} m\varphi}}{\sqrt{2\pi}} {\rm i}^{m+|m|}\sqrt{(\ell+\frac{1}{2})\frac{(\ell-m)!}{(\ell+m)!}} P_\ell^m(\cos\theta).
90+
```
8791
"""
8892
sphevaluate(θ, φ, L, M) = sphevaluatepi/π, φ/π, L, M)
8993

0 commit comments

Comments
 (0)