Skip to content

Commit 8814615

Browse files
better docstrings
1 parent f4625ff commit 8814615

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/nufft.jl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ doc"""
202202
Computes a nonuniform fast Fourier transform of type I:
203203
204204
```math
205-
f_j = \sum_{k=1}^N c_k e^{-2\pi{\rm i} (j-1)/N \omega_k},\quad{\rm for}\quad 1 \le j \le N.
205+
f_j = \sum_{k=0}^{N-1} c_k e^{-2\pi{\rm i} \frac{j}{N} \omega_k},\quad{\rm for}\quad 0 \le j \le N-1.
206206
```
207207
"""
208208
nufft1{T<:AbstractFloat}(c::AbstractVector, ω::AbstractVector{T}, ϵ::T) = plan_nufft1(ω, ϵ)*c
@@ -211,7 +211,7 @@ doc"""
211211
Computes a nonuniform fast Fourier transform of type II:
212212
213213
```math
214-
f_j = \sum_{k=1}^N c_k e^{-2\pi{\rm i} x_j (k-1)},\quad{\rm for}\quad 1 \le j \le N.
214+
f_j = \sum_{k=0}^{N-1} c_k e^{-2\pi{\rm i} x_j k},\quad{\rm for}\quad 0 \le j \le N-1.
215215
```
216216
"""
217217
nufft2{T<:AbstractFloat}(c::AbstractVector, x::AbstractVector{T}, ϵ::T) = plan_nufft2(x, ϵ)*c
@@ -220,7 +220,7 @@ doc"""
220220
Computes a nonuniform fast Fourier transform of type III:
221221
222222
```math
223-
f_j = \sum_{k=1}^N c_k e^{-2\pi{\rm i} x_j \omega_k},\quad{\rm for}\quad 1 \le j \le N.
223+
f_j = \sum_{k=0}^{N-1} c_k e^{-2\pi{\rm i} x_j \omega_k},\quad{\rm for}\quad 0 \le j \le N-1.
224224
```
225225
"""
226226
nufft3{T<:AbstractFloat}(c::AbstractVector, x::AbstractVector{T}, ω::AbstractVector{T}, ϵ::T) = plan_nufft3(x, ω, ϵ)*c
@@ -286,7 +286,7 @@ doc"""
286286
Computes a 2D nonuniform fast Fourier transform of type I-I:
287287
288288
```math
289-
f_{j_1,j_2} = \sum_{k_1=1}^M\sum_{k_2=1}^N C_{k_1,k_2} e^{-2\pi{\rm i} ((j_1-1)/M \omega_{k_1} + (j_2-1)/N \pi_{k_2})},\quad{\rm for}\quad 1 \le j_1 \le M,\quad 1 \le j_2 \le N.
289+
f_{i,j} = \sum_{k=0}^{M-1}\sum_{\ell=0}^{N-1} C_{k,\ell} e^{-2\pi{\rm i} (\frac{i}{M} \omega_k + \frac{j}{N} \pi_{\ell})},\quad{\rm for}\quad 0 \le i \le M-1,\quad 0 \le j \le N-1.
290290
```
291291
"""
292292
nufft1{T<:AbstractFloat}(C::Matrix, ω::AbstractVector{T}, π::AbstractVector{T}, ϵ::T) = plan_nufft1(ω, π, ϵ)*C
@@ -295,7 +295,7 @@ doc"""
295295
Computes a 2D nonuniform fast Fourier transform of type II-II:
296296
297297
```math
298-
f_{j_1,j_2} = \sum_{k_1=1}^M\sum_{k_2=1}^N C_{k_1,k_2} e^{-2\pi{\rm i} (x_{j_1}(k_1-1) + x_{j_2}(k_2-1))},\quad{\rm for}\quad 1 \le j_1 \le M,\quad 1 \le j_2 \le N.
298+
f_{i,j} = \sum_{k=0}^{M-1}\sum_{\ell=0}^{N-1} C_{k,\ell} e^{-2\pi{\rm i} (x_i k + x_j \ell)},\quad{\rm for}\quad 0 \le i \le M-1,\quad 0 \le j \le N-1.
299299
```
300300
"""
301301
nufft2{T<:AbstractFloat}(C::Matrix, x::AbstractVector{T}, y::AbstractVector{T}, ϵ::T) = plan_nufft2(x, y, ϵ)*C

0 commit comments

Comments
 (0)