annotate src/fftw-3.3.5/doc/html/One_002ddimensional-distributions.html @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents 2cd0e3b3e1fd
children
rev   line source
Chris@42 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
Chris@42 2 <html>
Chris@42 3 <!-- This manual is for FFTW
Chris@42 4 (version 3.3.5, 30 July 2016).
Chris@42 5
Chris@42 6 Copyright (C) 2003 Matteo Frigo.
Chris@42 7
Chris@42 8 Copyright (C) 2003 Massachusetts Institute of Technology.
Chris@42 9
Chris@42 10 Permission is granted to make and distribute verbatim copies of this
Chris@42 11 manual provided the copyright notice and this permission notice are
Chris@42 12 preserved on all copies.
Chris@42 13
Chris@42 14 Permission is granted to copy and distribute modified versions of this
Chris@42 15 manual under the conditions for verbatim copying, provided that the
Chris@42 16 entire resulting derived work is distributed under the terms of a
Chris@42 17 permission notice identical to this one.
Chris@42 18
Chris@42 19 Permission is granted to copy and distribute translations of this manual
Chris@42 20 into another language, under the above conditions for modified versions,
Chris@42 21 except that this permission notice may be stated in a translation
Chris@42 22 approved by the Free Software Foundation. -->
Chris@42 23 <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
Chris@42 24 <head>
Chris@42 25 <title>FFTW 3.3.5: One-dimensional distributions</title>
Chris@42 26
Chris@42 27 <meta name="description" content="FFTW 3.3.5: One-dimensional distributions">
Chris@42 28 <meta name="keywords" content="FFTW 3.3.5: One-dimensional distributions">
Chris@42 29 <meta name="resource-type" content="document">
Chris@42 30 <meta name="distribution" content="global">
Chris@42 31 <meta name="Generator" content="makeinfo">
Chris@42 32 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris@42 33 <link href="index.html#Top" rel="start" title="Top">
Chris@42 34 <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
Chris@42 35 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
Chris@42 36 <link href="MPI-Data-Distribution.html#MPI-Data-Distribution" rel="up" title="MPI Data Distribution">
Chris@42 37 <link href="Multi_002ddimensional-MPI-DFTs-of-Real-Data.html#Multi_002ddimensional-MPI-DFTs-of-Real-Data" rel="next" title="Multi-dimensional MPI DFTs of Real Data">
Chris@42 38 <link href="Transposed-distributions.html#Transposed-distributions" rel="prev" title="Transposed distributions">
Chris@42 39 <style type="text/css">
Chris@42 40 <!--
Chris@42 41 a.summary-letter {text-decoration: none}
Chris@42 42 blockquote.smallquotation {font-size: smaller}
Chris@42 43 div.display {margin-left: 3.2em}
Chris@42 44 div.example {margin-left: 3.2em}
Chris@42 45 div.indentedblock {margin-left: 3.2em}
Chris@42 46 div.lisp {margin-left: 3.2em}
Chris@42 47 div.smalldisplay {margin-left: 3.2em}
Chris@42 48 div.smallexample {margin-left: 3.2em}
Chris@42 49 div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
Chris@42 50 div.smalllisp {margin-left: 3.2em}
Chris@42 51 kbd {font-style:oblique}
Chris@42 52 pre.display {font-family: inherit}
Chris@42 53 pre.format {font-family: inherit}
Chris@42 54 pre.menu-comment {font-family: serif}
Chris@42 55 pre.menu-preformatted {font-family: serif}
Chris@42 56 pre.smalldisplay {font-family: inherit; font-size: smaller}
Chris@42 57 pre.smallexample {font-size: smaller}
Chris@42 58 pre.smallformat {font-family: inherit; font-size: smaller}
Chris@42 59 pre.smalllisp {font-size: smaller}
Chris@42 60 span.nocodebreak {white-space:nowrap}
Chris@42 61 span.nolinebreak {white-space:nowrap}
Chris@42 62 span.roman {font-family:serif; font-weight:normal}
Chris@42 63 span.sansserif {font-family:sans-serif; font-weight:normal}
Chris@42 64 ul.no-bullet {list-style: none}
Chris@42 65 -->
Chris@42 66 </style>
Chris@42 67
Chris@42 68
Chris@42 69 </head>
Chris@42 70
Chris@42 71 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
Chris@42 72 <a name="One_002ddimensional-distributions"></a>
Chris@42 73 <div class="header">
Chris@42 74 <p>
Chris@42 75 Previous: <a href="Transposed-distributions.html#Transposed-distributions" accesskey="p" rel="prev">Transposed distributions</a>, Up: <a href="MPI-Data-Distribution.html#MPI-Data-Distribution" accesskey="u" rel="up">MPI Data Distribution</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
Chris@42 76 </div>
Chris@42 77 <hr>
Chris@42 78 <a name="One_002ddimensional-distributions-1"></a>
Chris@42 79 <h4 class="subsection">6.4.4 One-dimensional distributions</h4>
Chris@42 80
Chris@42 81 <p>For one-dimensional distributed DFTs using FFTW, matters are slightly
Chris@42 82 more complicated because the data distribution is more closely tied to
Chris@42 83 how the algorithm works. In particular, you can no longer pass an
Chris@42 84 arbitrary block size and must accept FFTW&rsquo;s default; also, the block
Chris@42 85 sizes may be different for input and output. Also, the data
Chris@42 86 distribution depends on the flags and transform direction, in order
Chris@42 87 for forward and backward transforms to work correctly.
Chris@42 88 </p>
Chris@42 89 <div class="example">
Chris@42 90 <pre class="example">ptrdiff_t fftw_mpi_local_size_1d(ptrdiff_t n0, MPI_Comm comm,
Chris@42 91 int sign, unsigned flags,
Chris@42 92 ptrdiff_t *local_ni, ptrdiff_t *local_i_start,
Chris@42 93 ptrdiff_t *local_no, ptrdiff_t *local_o_start);
Chris@42 94 </pre></div>
Chris@42 95 <a name="index-fftw_005fmpi_005flocal_005fsize_005f1d"></a>
Chris@42 96
Chris@42 97 <p>This function computes the data distribution for a 1d transform of
Chris@42 98 size <code>n0</code> with the given transform <code>sign</code> and <code>flags</code>.
Chris@42 99 Both input and output data use block distributions. The input on the
Chris@42 100 current process will consist of <code>local_ni</code> numbers starting at
Chris@42 101 index <code>local_i_start</code>; e.g. if only a single process is used,
Chris@42 102 then <code>local_ni</code> will be <code>n0</code> and <code>local_i_start</code> will
Chris@42 103 be <code>0</code>. Similarly for the output, with <code>local_no</code> numbers
Chris@42 104 starting at index <code>local_o_start</code>. The return value of
Chris@42 105 <code>fftw_mpi_local_size_1d</code> will be the total number of elements to
Chris@42 106 allocate on the current process (which might be slightly larger than
Chris@42 107 the local size due to intermediate steps in the algorithm).
Chris@42 108 </p>
Chris@42 109 <p>As mentioned above (see <a href="Load-balancing.html#Load-balancing">Load balancing</a>), the data will be divided
Chris@42 110 equally among the processes if <code>n0</code> is divisible by the
Chris@42 111 <em>square</em> of the number of processes. In this case,
Chris@42 112 <code>local_ni</code> will equal <code>local_no</code>. Otherwise, they may be
Chris@42 113 different.
Chris@42 114 </p>
Chris@42 115 <p>For some applications, such as convolutions, the order of the output
Chris@42 116 data is irrelevant. In this case, performance can be improved by
Chris@42 117 specifying that the output data be stored in an FFTW-defined
Chris@42 118 &ldquo;scrambled&rdquo; format. (In particular, this is the analogue of
Chris@42 119 transposed output in the multidimensional case: scrambled output saves
Chris@42 120 a communications step.) If you pass <code>FFTW_MPI_SCRAMBLED_OUT</code> in
Chris@42 121 the flags, then the output is stored in this (undocumented) scrambled
Chris@42 122 order. Conversely, to perform the inverse transform of data in
Chris@42 123 scrambled order, pass the <code>FFTW_MPI_SCRAMBLED_IN</code> flag.
Chris@42 124 <a name="index-FFTW_005fMPI_005fSCRAMBLED_005fOUT"></a>
Chris@42 125 <a name="index-FFTW_005fMPI_005fSCRAMBLED_005fIN"></a>
Chris@42 126 </p>
Chris@42 127
Chris@42 128 <p>In MPI FFTW, only composite sizes <code>n0</code> can be parallelized; we
Chris@42 129 have not yet implemented a parallel algorithm for large prime sizes.
Chris@42 130 </p>
Chris@42 131 <hr>
Chris@42 132 <div class="header">
Chris@42 133 <p>
Chris@42 134 Previous: <a href="Transposed-distributions.html#Transposed-distributions" accesskey="p" rel="prev">Transposed distributions</a>, Up: <a href="MPI-Data-Distribution.html#MPI-Data-Distribution" accesskey="u" rel="up">MPI Data Distribution</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
Chris@42 135 </div>
Chris@42 136
Chris@42 137
Chris@42 138
Chris@42 139 </body>
Chris@42 140 </html>