Skip to content

Commit 6315ae6

Browse files
rearrange docstrings
1 parent bd3b3bb commit 6315ae6

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

src/nufft.jl

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,7 @@ immutable NUFFTPlan{N,T,FFT} <: Base.DFT.Plan{T}
1414
end
1515

1616
doc"""
17-
Pre-computes a nonuniform fast Fourier transform of type I:
18-
19-
```math
20-
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.
21-
```
17+
Pre-computes a nonuniform fast Fourier transform of type I.
2218
"""
2319
function plan_nufft1{T<:AbstractFloat}::AbstractVector{T}, ϵ::T)
2420
N = length(ω)
@@ -37,11 +33,7 @@ function plan_nufft1{T<:AbstractFloat}(ω::AbstractVector{T}, ϵ::T)
3733
end
3834

3935
doc"""
40-
Pre-computes a nonuniform fast Fourier transform of type II:
41-
42-
```math
43-
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.
44-
```
36+
Pre-computes a nonuniform fast Fourier transform of type II.
4537
"""
4638
function plan_nufft2{T<:AbstractFloat}(x::AbstractVector{T}, ϵ::T)
4739
N = length(x)
@@ -59,11 +51,7 @@ function plan_nufft2{T<:AbstractFloat}(x::AbstractVector{T}, ϵ::T)
5951
end
6052

6153
doc"""
62-
Pre-computes a nonuniform fast Fourier transform of type III:
63-
64-
```math
65-
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.
66-
```
54+
Pre-computes a nonuniform fast Fourier transform of type III.
6755
"""
6856
function plan_nufft3{T<:AbstractFloat}(x::AbstractVector{T}, ω::AbstractVector{T}, ϵ::T)
6957
N = length(x)
@@ -185,17 +173,29 @@ function recombine_rows!{T}(temp::Matrix{T}, t::Vector{Int}, temp2::Matrix{T})
185173
end
186174

187175
doc"""
188-
Computes a nonuniform fast Fourier transform of type I.
176+
Computes a nonuniform fast Fourier transform of type I:
177+
178+
```math
179+
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.
180+
```
189181
"""
190182
nufft1{T<:AbstractFloat}(c::AbstractVector, ω::AbstractVector{T}, ϵ::T) = plan_nufft1(ω, ϵ)*c
191183

192184
doc"""
193-
Computes a nonuniform fast Fourier transform of type II.
185+
Computes a nonuniform fast Fourier transform of type II:
186+
187+
```math
188+
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.
189+
```
194190
"""
195191
nufft2{T<:AbstractFloat}(c::AbstractVector, x::AbstractVector{T}, ϵ::T) = plan_nufft2(x, ϵ)*c
196192

197193
doc"""
198-
Computes a nonuniform fast Fourier transform of type III.
194+
Computes a nonuniform fast Fourier transform of type III:
195+
196+
```math
197+
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.
198+
```
199199
"""
200200
nufft3{T<:AbstractFloat}(c::AbstractVector, x::AbstractVector{T}, ω::AbstractVector{T}, ϵ::T) = plan_nufft3(x, ω, ϵ)*c
201201

0 commit comments

Comments
 (0)