small doc improvement

SciNim · Sep 15, 2020 · 4e2f68a · 4e2f68a
1 parent 5bc9d4d
commit 4e2f68a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/doc/fftw3.html b/doc/fftw3.html
@@ -466,7 +466,7 @@ <h1><a class="toc-backref" id="examples" href="#examples">Examples</a></h1>C-Bin
 <span class="Comment"># Create a plan</span>
 <span class="Keyword">var</span> <span class="Identifier">plan</span> <span class="Punctuation">:</span> <span class="Identifier">fftw_plan</span> <span class="Operator">=</span> <span class="Identifier">fftw_plan_dft</span><span class="Punctuation">(</span><span class="Identifier">input</span><span class="Punctuation">,</span> <span class="Identifier">output</span><span class="Punctuation">,</span> <span class="Identifier">FFTW_FORWARD</span><span class="Punctuation">,</span> <span class="Identifier">FFTW_ESTIMATE</span><span class="Punctuation">)</span>
 <span class="Comment"># Execute plan in-place</span>
-<span class="Identifier">fftw_execute</span><span class="Punctuation">(</span><span class="Identifier">plan</span><span class="Punctuation">)</span></pre></p>
+<span class="Identifier">fftw_execute</span><span class="Punctuation">(</span><span class="Identifier">plan</span><span class="Punctuation">)</span></pre>Arraymancer non-official API for ease of useFFT Shift Because FFT-Shift is used in many FFT based AlgorithmFFTW Execute APIFFTW Plan APIFFTW Plan Many APIFFTW &quot;Guru&quot; API This is the &quot;I know what I'm doing and want to optimize every last bits of performance&quot; API of FFTWFFTW Utility &amp; Cleanup API</p>
   <div class="section" id="7">
 <h1><a class="toc-backref" href="#7">Types</a></h1>
 <dl class="item">
@@ -1440,7 +1440,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
       <div class="twelve-columns footer">
         <span class="nim-sprite"></span>
         <br/>
-        <small style="color: var(--hint);">Made with Nim. Generated: 2020-07-24 10:10:07 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2020-09-15 09:29:24 UTC</small>
       </div>
     </div>
   </div>

diff --git a/src/fftw3.nim b/src/fftw3.nim
@@ -42,7 +42,7 @@
 ##   # Execute plan in-place
 ##   fftw_execute(plan)
 
-# Arraymancer non-official API for ease of use
+## Arraymancer non-official API for ease of use
 
 import arraymancer
 import sequtils
@@ -97,7 +97,8 @@ type
   fftw_complex* = Complex64
   fftw_plan* = pointer
 
-# Utility procedures
+## FFT Shift
+## Because FFT-Shift is used in many FFT based Algorithm
 proc circshift_impl[T](t: Tensor[T], xshift: int, yshift: int, zshift: int): Tensor[T]=
   assert(t.rank == 3)
   var X = t.shape[0]
@@ -171,6 +172,7 @@ proc ifftshift*[T](t: Tensor[T]): Tensor[T]=
   let zshift = (t.shape[2]+1) div 2
   result = circshift(t, @[xshift.int, yshift.int, zshift.int])
 
+## FFTW Execute API
 
 proc fftw_execute*(p: fftw_plan) {.cdecl, importc: "fftw_execute",
                                    dynlib: LibraryName.}
@@ -205,7 +207,6 @@ proc fftw_execute_dft_c2r*(p: fftw_plan, input: Tensor[fftw_complex],   output:
   fftw_execute_dft_c2r(p, input.get_data_ptr, cast[ptr cdouble](output.get_data_ptr))
 
 
-
 proc fftw_execute_split_dft*(p: fftw_plan; ri: ptr cdouble; ii: ptr cdouble;
                              ro: ptr cdouble; io: ptr cdouble) {.cdecl,
     importc: "fftw_execute_split_dft", dynlib: LibraryName.}
@@ -219,7 +220,7 @@ proc fftw_execute_split_dft_c2r*(p: fftw_plan; ri: ptr cdouble; ii: ptr cdouble;
     importc: "fftw_execute_split_dft_c2r", dynlib: LibraryName.}
 
 
-
+## FFTW Plan API
 
 proc fftw_plan_dft*(rank: cint; n: ptr cint; `in`: ptr fftw_complex;
                     `out`: ptr fftw_complex; sign: cint; flags: cuint): fftw_plan {.
@@ -264,7 +265,6 @@ proc fftw_plan_dft_3d*(input: Tensor[fftw_complex], output: Tensor[fftw_complex]
   result = fftw_plan_dft_3d(shape[0], shape[1], shape[2], input.get_data_ptr, output.get_data_ptr,sign, flags)
 
 
-
 proc fftw_plan_dft_r2c*(rank: cint; n: ptr cint; `in`: ptr cdouble;
                         `out`: ptr fftw_complex; flags: cuint): fftw_plan {.
     cdecl, importc: "fftw_plan_dft_r2c", dynlib: LibraryName.}
@@ -395,6 +395,7 @@ proc fftw_plan_r2r_3d*(input: Tensor[float64], output: Tensor[float64], kinds: s
   let shape : seq[cint] = map(input.shape.toSeq, proc(x: int): cint= x.cint)
   result = fftw_plan_r2r_3d(shape[0], shape[1], shape[2], cast[ptr cdouble](input.get_data_ptr), cast[ptr cdouble](output.get_data_ptr), kinds[0], kinds[1], kinds[2], flags)
 
+## FFTW Plan Many API
 
 proc fftw_plan_many_dft*(rank: cint; n: ptr cint; howmany: cint;
                          `in`: ptr fftw_complex; inembed: ptr cint;
@@ -428,6 +429,8 @@ proc fftw_plan_many_r2r*(rank: cint; n: ptr cint; howmany: cint;
 
 
 
+## FFTW "Guru" API
+## This is the "I know what I'm doing and want to optimize every last bits of performance" API of FFTW
 
 proc fftw_plan_guru_dft*(rank: cint; dims: ptr fftw_iodim; howmany_rank: cint;
                          howmany_dims: ptr fftw_iodim; `in`: ptr fftw_complex;
@@ -508,6 +511,8 @@ proc fftw_plan_guru64_r2r*(rank: cint; dims: ptr fftw_iodim64;
                            kind: ptr fftw_r2r_kind; flags: cuint): fftw_plan {.
     cdecl, importc: "fftw_plan_guru64_r2r", dynlib: LibraryName.}
 
+## FFTW Utility & Cleanup API
+
 proc fftw_destroy_plan*(p: fftw_plan) {.cdecl, importc: "fftw_destroy_plan",
                                         dynlib: LibraryName.}
 proc fftw_forget_wisdom*() {.cdecl, importc: "fftw_forget_wisdom",