fftshift in its own file

SciNim · Feb 3, 2021 · 53b3b41 · 53b3b41
1 parent a5cf4a0
commit 53b3b41
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 140 deletions.
diff --git a/docs/fftw3.html b/docs/fftw3.html
@@ -969,7 +969,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
 <div class="section" id="19">
 <h1><a class="toc-backref" href="#19">Exports</a></h1>
 <dl class="item">
-<a href="fftw3/libutils.html#fftw_plan"><span class="Identifier">fftw_plan</span></a>, <a href="fftw3/libutils.html#fftw_r2r_kind"><span class="Identifier">fftw_r2r_kind</span></a>, <a href="fftw3/fftshift.html#fftshift,Tensor[T]"><span class="Identifier">fftshift</span></a>, <a href="fftw3/fftshift.html#ifftshift,Tensor[T]"><span class="Identifier">ifftshift</span></a>, <a href="fftw3/fftshift.html#circshift,Tensor[T],seq[int]"><span class="Identifier">circshift</span></a>, <a href="fftw3/fftshift.html#J,openArray[int]"><span class="Identifier">J</span></a>, <a href="fftw3/fftshift.html#get2DCoord,int,int,int"><span class="Identifier">get2DCoord</span></a>, <a href="fftw3/fftshift.html#get3DCoord,int,int,int,int"><span class="Identifier">get3DCoord</span></a>, <a href="fftw3/fftshift.html#K,openArray[int]"><span class="Identifier">K</span></a>, <a href="fftw3/fftshift.html#get2DCoord,int,Tensor[T]"><span class="Identifier">get2DCoord</span></a>, <a href="fftw3/fftshift.html#get3DCoord,int,Tensor[T]"><span class="Identifier">get3DCoord</span></a>, <a href="fftw3/fftshift.html#I,openArray[int]"><span class="Identifier">I</span></a>
+<a href="fftw3/libutils.html#fftw_plan"><span class="Identifier">fftw_plan</span></a>, <a href="fftw3/libutils.html#fftw_r2r_kind"><span class="Identifier">fftw_r2r_kind</span></a>, <a href="fftw3/fftshift.html#ifftshift,Tensor[T]"><span class="Identifier">ifftshift</span></a>, <a href="fftw3/fftshift.html#fftshift,Tensor[T]"><span class="Identifier">fftshift</span></a>, <a href="fftw3/fftshift.html#circshift,Tensor[T],seq[int]"><span class="Identifier">circshift</span></a>
 </dl></div>
 
   </div>
@@ -979,7 +979,7 @@ <h1><a class="toc-backref" href="#19">Exports</a></h1>
       <div class="twelve-columns footer">
         <span class="nim-sprite"></span>
         <br/>
-        <small style="color: var(--hint);">Made with Nim. Generated: 2021-02-03 11:06:17 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2021-02-03 11:12:49 UTC</small>
       </div>
     </div>
   </div>

diff --git a/docs/fftw3/fftshift.html b/docs/fftw3/fftshift.html
@@ -98,45 +98,16 @@ <h1 class="title">fftw3/fftshift</h1>
       <li><a class="reference" href="#circshift%2CTensor%5BT%5D%2Cseq%5Bint%5D"
     title="circshift[T](t: Tensor[T]; shift: seq[int]): Tensor[T]">circshift,<wbr>Tensor[T],<wbr>seq[int]</a></li>
 
-  </ul>
-  <ul class="simple nested-toc-section">I
-      <li><a class="reference" href="#I%2CopenArray%5Bint%5D"
-    title="I(coord: openArray[int]): int">I,<wbr>openArray[int]</a></li>
-
   </ul>
   <ul class="simple nested-toc-section">ifftshift
       <li><a class="reference" href="#ifftshift%2CTensor%5BT%5D"
     title="ifftshift[T](t: Tensor[T]): Tensor[T]">ifftshift,<wbr>Tensor[T]</a></li>
 
-  </ul>
-  <ul class="simple nested-toc-section">J
-      <li><a class="reference" href="#J%2CopenArray%5Bint%5D"
-    title="J(coord: openArray[int]): int">J,<wbr>openArray[int]</a></li>
-
-  </ul>
-  <ul class="simple nested-toc-section">K
-      <li><a class="reference" href="#K%2CopenArray%5Bint%5D"
-    title="K(coord: openArray[int]): int">K,<wbr>openArray[int]</a></li>
-
   </ul>
   <ul class="simple nested-toc-section">fftshift
       <li><a class="reference" href="#fftshift%2CTensor%5BT%5D"
     title="fftshift[T](t: Tensor[T]): Tensor[T]">fftshift,<wbr>Tensor[T]</a></li>
 
-  </ul>
-  <ul class="simple nested-toc-section">get3DCoord
-      <li><a class="reference" href="#get3DCoord%2Cint%2Cint%2Cint%2Cint"
-    title="get3DCoord(index: int; Nx, Ny, Nz: int): array[3, int]">get3DCoord,<wbr>int,<wbr>int,<wbr>int,<wbr>int</a></li>
-  <li><a class="reference" href="#get3DCoord%2Cint%2CTensor%5BT%5D"
-    title="get3DCoord[T](index: int; t: Tensor[T]): array[3, int]">get3DCoord,<wbr>int,<wbr>Tensor[T]</a></li>
-
-  </ul>
-  <ul class="simple nested-toc-section">get2DCoord
-      <li><a class="reference" href="#get2DCoord%2Cint%2Cint%2Cint"
-    title="get2DCoord(index: int; Nx, Ny: int): array[2, int]">get2DCoord,<wbr>int,<wbr>int,<wbr>int</a></li>
-  <li><a class="reference" href="#get2DCoord%2Cint%2CTensor%5BT%5D"
-    title="get2DCoord[T](index: int; t: Tensor[T]): array[2, int]">get2DCoord,<wbr>int,<wbr>Tensor[T]</a></li>
-
   </ul>
 
   </ul>
@@ -152,57 +123,6 @@ <h1 class="title">fftw3/fftshift</h1>
   <div class="section" id="12">
 <h1><a class="toc-backref" href="#12">Procs</a></h1>
 <dl class="item">
-<a id="get2DCoord,int,int,int"></a>
-<dt><pre><span class="Keyword">proc</span> <a href="#get2DCoord%2Cint%2Cint%2Cint"><span class="Identifier">get2DCoord</span></a><span class="Other">(</span><span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">Nx</span><span class="Other">,</span> <span class="Identifier">Ny</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">2</span><span class="Other">,</span> <span class="Identifier">int</span><span class="Other">]</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
-    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
-<dd>
-
-
-
-</dd>
-<a id="get3DCoord,int,int,int,int"></a>
-<dt><pre><span class="Keyword">proc</span> <a href="#get3DCoord%2Cint%2Cint%2Cint%2Cint"><span class="Identifier">get3DCoord</span></a><span class="Other">(</span><span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">Nx</span><span class="Other">,</span> <span class="Identifier">Ny</span><span class="Other">,</span> <span class="Identifier">Nz</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">3</span><span class="Other">,</span> <span class="Identifier">int</span><span class="Other">]</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span>
-    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
-<dd>
-
-
-
-</dd>
-<a id="get2DCoord,int,Tensor[T]"></a>
-<dt><pre><span class="Keyword">proc</span> <a href="#get2DCoord%2Cint%2CTensor%5BT%5D"><span class="Identifier">get2DCoord</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">Tensor</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">2</span><span class="Other">,</span> <span class="Identifier">int</span><span class="Other">]</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span></span><span class="Other">.}</span></span></pre></dt>
-<dd>
-
-
-
-</dd>
-<a id="get3DCoord,int,Tensor[T]"></a>
-<dt><pre><span class="Keyword">proc</span> <a href="#get3DCoord%2Cint%2CTensor%5BT%5D"><span class="Identifier">get3DCoord</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">Tensor</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">3</span><span class="Other">,</span> <span class="Identifier">int</span><span class="Other">]</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span></span><span class="Other">.}</span></span></pre></dt>
-<dd>
-
-
-
-</dd>
-<a id="I,openArray[int]"></a>
-<dt><pre><span class="Keyword">proc</span> <a href="#I%2CopenArray%5Bint%5D"><span class="Identifier">I</span></a><span class="Other">(</span><span class="Identifier">coord</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
-<dd>
-
-
-
-</dd>
-<a id="J,openArray[int]"></a>
-<dt><pre><span class="Keyword">proc</span> <a href="#J%2CopenArray%5Bint%5D"><span class="Identifier">J</span></a><span class="Other">(</span><span class="Identifier">coord</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
-<dd>
-
-
-
-</dd>
-<a id="K,openArray[int]"></a>
-<dt><pre><span class="Keyword">proc</span> <a href="#K%2CopenArray%5Bint%5D"><span class="Identifier">K</span></a><span class="Other">(</span><span class="Identifier">coord</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
-<dd>
-
-
-
-</dd>
 <a id="circshift,Tensor[T],seq[int]"></a>
 <dt><pre><span class="Keyword">proc</span> <a href="#circshift%2CTensor%5BT%5D%2Cseq%5Bint%5D"><span class="Identifier">circshift</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">Tensor</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">shift</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Tensor</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
 <dd>
@@ -244,7 +164,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: 2021-02-03 11:06:15 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2021-02-03 11:12:47 UTC</small>
       </div>
     </div>
   </div>

diff --git a/docs/fftw3/fftshift.idx b/docs/fftw3/fftshift.idx
@@ -1,10 +1,3 @@
-get2DCoord	fftw3/fftshift.html#get2DCoord,int,int,int	fftshift: get2DCoord(index: int; Nx, Ny: int): array[2, int]	
-get3DCoord	fftw3/fftshift.html#get3DCoord,int,int,int,int	fftshift: get3DCoord(index: int; Nx, Ny, Nz: int): array[3, int]	
-get2DCoord	fftw3/fftshift.html#get2DCoord,int,Tensor[T]	fftshift: get2DCoord[T](index: int; t: Tensor[T]): array[2, int]	
-get3DCoord	fftw3/fftshift.html#get3DCoord,int,Tensor[T]	fftshift: get3DCoord[T](index: int; t: Tensor[T]): array[3, int]	
-I	fftw3/fftshift.html#I,openArray[int]	fftshift: I(coord: openArray[int]): int	
-J	fftw3/fftshift.html#J,openArray[int]	fftshift: J(coord: openArray[int]): int	
-K	fftw3/fftshift.html#K,openArray[int]	fftshift: K(coord: openArray[int]): int	
 circshift	fftw3/fftshift.html#circshift,Tensor[T],seq[int]	fftshift: circshift[T](t: Tensor[T]; shift: seq[int]): Tensor[T]	
 fftshift	fftw3/fftshift.html#fftshift,Tensor[T]	fftshift: fftshift[T](t: Tensor[T]): Tensor[T]	
 ifftshift	fftw3/fftshift.html#ifftshift,Tensor[T]	fftshift: ifftshift[T](t: Tensor[T]): Tensor[T]	
diff --git a/docs/fftw3/guru.html b/docs/fftw3/guru.html
@@ -440,7 +440,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: 2021-02-03 11:06:13 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2021-02-03 11:12:44 UTC</small>
       </div>
     </div>
   </div>

diff --git a/docs/fftw3/libutils.html b/docs/fftw3/libutils.html
@@ -433,7 +433,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: 2021-02-03 11:06:13 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2021-02-03 11:12:44 UTC</small>
       </div>
     </div>
   </div>

diff --git a/docs/fftw3/wisdom.html b/docs/fftw3/wisdom.html
@@ -259,7 +259,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: 2021-02-03 11:06:13 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2021-02-03 11:12:44 UTC</small>
       </div>
     </div>
   </div>

diff --git a/docs/theindex.html b/docs/theindex.html
@@ -676,34 +676,10 @@ <h1 class="title">Index</h1>
 <li><a class="reference external"
           data-doc-search-tag="libutils: fftw_write_char_func" href="fftw3/libutils.html#fftw_write_char_func">libutils: fftw_write_char_func</a></li>
           </ul></dd>
-<dt><a name="get2DCoord" href="#get2DCoord"><span>get2DCoord:</span></a></dt><dd><ul class="simple">
-<li><a class="reference external"
-          data-doc-search-tag="fftshift: get2DCoord(index: int; Nx, Ny: int): array[2, int]" href="fftw3/fftshift.html#get2DCoord%2Cint%2Cint%2Cint">fftshift: get2DCoord(index: int; Nx, Ny: int): array[2, int]</a></li>
-          <li><a class="reference external"
-          data-doc-search-tag="fftshift: get2DCoord[T](index: int; t: Tensor[T]): array[2, int]" href="fftw3/fftshift.html#get2DCoord%2Cint%2CTensor%5BT%5D">fftshift: get2DCoord[T](index: int; t: Tensor[T]): array[2, int]</a></li>
-          </ul></dd>
-<dt><a name="get3DCoord" href="#get3DCoord"><span>get3DCoord:</span></a></dt><dd><ul class="simple">
-<li><a class="reference external"
-          data-doc-search-tag="fftshift: get3DCoord(index: int; Nx, Ny, Nz: int): array[3, int]" href="fftw3/fftshift.html#get3DCoord%2Cint%2Cint%2Cint%2Cint">fftshift: get3DCoord(index: int; Nx, Ny, Nz: int): array[3, int]</a></li>
-          <li><a class="reference external"
-          data-doc-search-tag="fftshift: get3DCoord[T](index: int; t: Tensor[T]): array[3, int]" href="fftw3/fftshift.html#get3DCoord%2Cint%2CTensor%5BT%5D">fftshift: get3DCoord[T](index: int; t: Tensor[T]): array[3, int]</a></li>
-          </ul></dd>
-<dt><a name="I" href="#I"><span>I:</span></a></dt><dd><ul class="simple">
-<li><a class="reference external"
-          data-doc-search-tag="fftshift: I(coord: openArray[int]): int" href="fftw3/fftshift.html#I%2CopenArray%5Bint%5D">fftshift: I(coord: openArray[int]): int</a></li>
-          </ul></dd>
 <dt><a name="ifftshift" href="#ifftshift"><span>ifftshift:</span></a></dt><dd><ul class="simple">
 <li><a class="reference external"
           data-doc-search-tag="fftshift: ifftshift[T](t: Tensor[T]): Tensor[T]" href="fftw3/fftshift.html#ifftshift%2CTensor%5BT%5D">fftshift: ifftshift[T](t: Tensor[T]): Tensor[T]</a></li>
           </ul></dd>
-<dt><a name="J" href="#J"><span>J:</span></a></dt><dd><ul class="simple">
-<li><a class="reference external"
-          data-doc-search-tag="fftshift: J(coord: openArray[int]): int" href="fftw3/fftshift.html#J%2CopenArray%5Bint%5D">fftshift: J(coord: openArray[int]): int</a></li>
-          </ul></dd>
-<dt><a name="K" href="#K"><span>K:</span></a></dt><dd><ul class="simple">
-<li><a class="reference external"
-          data-doc-search-tag="fftshift: K(coord: openArray[int]): int" href="fftw3/fftshift.html#K%2CopenArray%5Bint%5D">fftshift: K(coord: openArray[int]): int</a></li>
-          </ul></dd>
 <dt><a name="ptrdiff_t" href="#ptrdiff_t"><span>ptrdiff_t:</span></a></dt><dd><ul class="simple">
 <li><a class="reference external"
           data-doc-search-tag="libutils: ptrdiff_t" href="fftw3/libutils.html#ptrdiff_t">libutils: ptrdiff_t</a></li>
@@ -717,7 +693,7 @@ <h1 class="title">Index</h1>
       <div class="twelve-columns footer">
         <span class="nim-sprite"></span>
         <br/>
-        <small style="color: var(--hint);">Made with Nim. Generated: 2021-02-03 11:06:17 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2021-02-03 11:12:49 UTC</small>
       </div>
     </div>
   </div>