Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.5/mpi/fftw3-mpi.h @ 43:5ea0608b923f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Current zlib source
author Chris Cannam
date Tue, 18 Oct 2016 14:33:52 +0100
parents 2cd0e3b3e1fd
children
rev   line source
Chris@42 1 /*
Chris@42 2 * Copyright (c) 2003, 2007-14 Matteo Frigo
Chris@42 3 * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
Chris@42 4 *
Chris@42 5 * The following statement of license applies *only* to this header file,
Chris@42 6 * and *not* to the other files distributed with FFTW or derived therefrom:
Chris@42 7 *
Chris@42 8 * Redistribution and use in source and binary forms, with or without
Chris@42 9 * modification, are permitted provided that the following conditions
Chris@42 10 * are met:
Chris@42 11 *
Chris@42 12 * 1. Redistributions of source code must retain the above copyright
Chris@42 13 * notice, this list of conditions and the following disclaimer.
Chris@42 14 *
Chris@42 15 * 2. Redistributions in binary form must reproduce the above copyright
Chris@42 16 * notice, this list of conditions and the following disclaimer in the
Chris@42 17 * documentation and/or other materials provided with the distribution.
Chris@42 18 *
Chris@42 19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
Chris@42 20 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
Chris@42 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
Chris@42 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
Chris@42 23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Chris@42 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
Chris@42 25 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
Chris@42 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
Chris@42 27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
Chris@42 28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Chris@42 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@42 30 */
Chris@42 31
Chris@42 32 /***************************** NOTE TO USERS *********************************
Chris@42 33 *
Chris@42 34 * THIS IS A HEADER FILE, NOT A MANUAL
Chris@42 35 *
Chris@42 36 * If you want to know how to use FFTW, please read the manual,
Chris@42 37 * online at http://www.fftw.org/doc/ and also included with FFTW.
Chris@42 38 * For a quick start, see the manual's tutorial section.
Chris@42 39 *
Chris@42 40 * (Reading header files to learn how to use a library is a habit
Chris@42 41 * stemming from code lacking a proper manual. Arguably, it's a
Chris@42 42 * *bad* habit in most cases, because header files can contain
Chris@42 43 * interfaces that are not part of the public, stable API.)
Chris@42 44 *
Chris@42 45 ****************************************************************************/
Chris@42 46
Chris@42 47 #ifndef FFTW3_MPI_H
Chris@42 48 #define FFTW3_MPI_H
Chris@42 49
Chris@42 50 #include "fftw3.h"
Chris@42 51 #include <mpi.h>
Chris@42 52
Chris@42 53 #ifdef __cplusplus
Chris@42 54 extern "C"
Chris@42 55 {
Chris@42 56 #endif /* __cplusplus */
Chris@42 57
Chris@42 58 struct fftw_mpi_ddim_do_not_use_me {
Chris@42 59 ptrdiff_t n; /* dimension size */
Chris@42 60 ptrdiff_t ib; /* input block */
Chris@42 61 ptrdiff_t ob; /* output block */
Chris@42 62 };
Chris@42 63
Chris@42 64 /*
Chris@42 65 huge second-order macro that defines prototypes for all API
Chris@42 66 functions. We expand this macro for each supported precision
Chris@42 67
Chris@42 68 XM: name-mangling macro (MPI)
Chris@42 69 X: name-mangling macro (serial)
Chris@42 70 R: real data type
Chris@42 71 C: complex data type
Chris@42 72 */
Chris@42 73
Chris@42 74 #define FFTW_MPI_DEFINE_API(XM, X, R, C) \
Chris@42 75 \
Chris@42 76 typedef struct fftw_mpi_ddim_do_not_use_me XM(ddim); \
Chris@42 77 \
Chris@42 78 FFTW_EXTERN void XM(init)(void); \
Chris@42 79 FFTW_EXTERN void XM(cleanup)(void); \
Chris@42 80 \
Chris@42 81 FFTW_EXTERN ptrdiff_t XM(local_size_many_transposed) \
Chris@42 82 (int rnk, const ptrdiff_t *n, ptrdiff_t howmany, \
Chris@42 83 ptrdiff_t block0, ptrdiff_t block1, MPI_Comm comm, \
Chris@42 84 ptrdiff_t *local_n0, ptrdiff_t *local_0_start, \
Chris@42 85 ptrdiff_t *local_n1, ptrdiff_t *local_1_start); \
Chris@42 86 FFTW_EXTERN ptrdiff_t XM(local_size_many) \
Chris@42 87 (int rnk, const ptrdiff_t *n, ptrdiff_t howmany, \
Chris@42 88 ptrdiff_t block0, MPI_Comm comm, \
Chris@42 89 ptrdiff_t *local_n0, ptrdiff_t *local_0_start); \
Chris@42 90 FFTW_EXTERN ptrdiff_t XM(local_size_transposed) \
Chris@42 91 (int rnk, const ptrdiff_t *n, MPI_Comm comm, \
Chris@42 92 ptrdiff_t *local_n0, ptrdiff_t *local_0_start, \
Chris@42 93 ptrdiff_t *local_n1, ptrdiff_t *local_1_start); \
Chris@42 94 FFTW_EXTERN ptrdiff_t XM(local_size) \
Chris@42 95 (int rnk, const ptrdiff_t *n, MPI_Comm comm, \
Chris@42 96 ptrdiff_t *local_n0, ptrdiff_t *local_0_start); \
Chris@42 97 FFTW_EXTERN ptrdiff_t XM(local_size_many_1d)( \
Chris@42 98 ptrdiff_t n0, ptrdiff_t howmany, \
Chris@42 99 MPI_Comm comm, int sign, unsigned flags, \
Chris@42 100 ptrdiff_t *local_ni, ptrdiff_t *local_i_start, \
Chris@42 101 ptrdiff_t *local_no, ptrdiff_t *local_o_start); \
Chris@42 102 FFTW_EXTERN ptrdiff_t XM(local_size_1d)( \
Chris@42 103 ptrdiff_t n0, MPI_Comm comm, int sign, unsigned flags, \
Chris@42 104 ptrdiff_t *local_ni, ptrdiff_t *local_i_start, \
Chris@42 105 ptrdiff_t *local_no, ptrdiff_t *local_o_start); \
Chris@42 106 FFTW_EXTERN ptrdiff_t XM(local_size_2d)( \
Chris@42 107 ptrdiff_t n0, ptrdiff_t n1, MPI_Comm comm, \
Chris@42 108 ptrdiff_t *local_n0, ptrdiff_t *local_0_start); \
Chris@42 109 FFTW_EXTERN ptrdiff_t XM(local_size_2d_transposed)( \
Chris@42 110 ptrdiff_t n0, ptrdiff_t n1, MPI_Comm comm, \
Chris@42 111 ptrdiff_t *local_n0, ptrdiff_t *local_0_start, \
Chris@42 112 ptrdiff_t *local_n1, ptrdiff_t *local_1_start); \
Chris@42 113 FFTW_EXTERN ptrdiff_t XM(local_size_3d)( \
Chris@42 114 ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, MPI_Comm comm, \
Chris@42 115 ptrdiff_t *local_n0, ptrdiff_t *local_0_start); \
Chris@42 116 FFTW_EXTERN ptrdiff_t XM(local_size_3d_transposed)( \
Chris@42 117 ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, MPI_Comm comm, \
Chris@42 118 ptrdiff_t *local_n0, ptrdiff_t *local_0_start, \
Chris@42 119 ptrdiff_t *local_n1, ptrdiff_t *local_1_start); \
Chris@42 120 \
Chris@42 121 FFTW_EXTERN X(plan) XM(plan_many_transpose) \
Chris@42 122 (ptrdiff_t n0, ptrdiff_t n1, \
Chris@42 123 ptrdiff_t howmany, ptrdiff_t block0, ptrdiff_t block1, \
Chris@42 124 R *in, R *out, MPI_Comm comm, unsigned flags); \
Chris@42 125 FFTW_EXTERN X(plan) XM(plan_transpose) \
Chris@42 126 (ptrdiff_t n0, ptrdiff_t n1, \
Chris@42 127 R *in, R *out, MPI_Comm comm, unsigned flags); \
Chris@42 128 \
Chris@42 129 FFTW_EXTERN X(plan) XM(plan_many_dft) \
Chris@42 130 (int rnk, const ptrdiff_t *n, ptrdiff_t howmany, \
Chris@42 131 ptrdiff_t block, ptrdiff_t tblock, C *in, C *out, \
Chris@42 132 MPI_Comm comm, int sign, unsigned flags); \
Chris@42 133 FFTW_EXTERN X(plan) XM(plan_dft) \
Chris@42 134 (int rnk, const ptrdiff_t *n, C *in, C *out, \
Chris@42 135 MPI_Comm comm, int sign, unsigned flags); \
Chris@42 136 FFTW_EXTERN X(plan) XM(plan_dft_1d) \
Chris@42 137 (ptrdiff_t n0, C *in, C *out, \
Chris@42 138 MPI_Comm comm, int sign, unsigned flags); \
Chris@42 139 FFTW_EXTERN X(plan) XM(plan_dft_2d) \
Chris@42 140 (ptrdiff_t n0, ptrdiff_t n1, C *in, C *out, \
Chris@42 141 MPI_Comm comm, int sign, unsigned flags); \
Chris@42 142 FFTW_EXTERN X(plan) XM(plan_dft_3d) \
Chris@42 143 (ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, C *in, C *out, \
Chris@42 144 MPI_Comm comm, int sign, unsigned flags); \
Chris@42 145 \
Chris@42 146 FFTW_EXTERN X(plan) XM(plan_many_r2r) \
Chris@42 147 (int rnk, const ptrdiff_t *n, ptrdiff_t howmany, \
Chris@42 148 ptrdiff_t iblock, ptrdiff_t oblock, R *in, R *out, \
Chris@42 149 MPI_Comm comm, const X(r2r_kind) *kind, unsigned flags); \
Chris@42 150 FFTW_EXTERN X(plan) XM(plan_r2r) \
Chris@42 151 (int rnk, const ptrdiff_t *n, R *in, R *out, \
Chris@42 152 MPI_Comm comm, const X(r2r_kind) *kind, unsigned flags); \
Chris@42 153 FFTW_EXTERN X(plan) XM(plan_r2r_2d) \
Chris@42 154 (ptrdiff_t n0, ptrdiff_t n1, R *in, R *out, MPI_Comm comm, \
Chris@42 155 X(r2r_kind) kind0, X(r2r_kind) kind1, unsigned flags); \
Chris@42 156 FFTW_EXTERN X(plan) XM(plan_r2r_3d) \
Chris@42 157 (ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, \
Chris@42 158 R *in, R *out, MPI_Comm comm, X(r2r_kind) kind0, \
Chris@42 159 X(r2r_kind) kind1, X(r2r_kind) kind2, unsigned flags); \
Chris@42 160 \
Chris@42 161 FFTW_EXTERN X(plan) XM(plan_many_dft_r2c) \
Chris@42 162 (int rnk, const ptrdiff_t *n, ptrdiff_t howmany, \
Chris@42 163 ptrdiff_t iblock, ptrdiff_t oblock, R *in, C *out, \
Chris@42 164 MPI_Comm comm, unsigned flags); \
Chris@42 165 FFTW_EXTERN X(plan) XM(plan_dft_r2c) \
Chris@42 166 (int rnk, const ptrdiff_t *n, R *in, C *out, \
Chris@42 167 MPI_Comm comm, unsigned flags); \
Chris@42 168 FFTW_EXTERN X(plan) XM(plan_dft_r2c_2d) \
Chris@42 169 (ptrdiff_t n0, ptrdiff_t n1, R *in, C *out, \
Chris@42 170 MPI_Comm comm, unsigned flags); \
Chris@42 171 FFTW_EXTERN X(plan) XM(plan_dft_r2c_3d) \
Chris@42 172 (ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, R *in, C *out, \
Chris@42 173 MPI_Comm comm, unsigned flags); \
Chris@42 174 \
Chris@42 175 FFTW_EXTERN X(plan) XM(plan_many_dft_c2r) \
Chris@42 176 (int rnk, const ptrdiff_t *n, ptrdiff_t howmany, \
Chris@42 177 ptrdiff_t iblock, ptrdiff_t oblock, C *in, R *out, \
Chris@42 178 MPI_Comm comm, unsigned flags); \
Chris@42 179 FFTW_EXTERN X(plan) XM(plan_dft_c2r) \
Chris@42 180 (int rnk, const ptrdiff_t *n, C *in, R *out, \
Chris@42 181 MPI_Comm comm, unsigned flags); \
Chris@42 182 FFTW_EXTERN X(plan) XM(plan_dft_c2r_2d) \
Chris@42 183 (ptrdiff_t n0, ptrdiff_t n1, C *in, R *out, \
Chris@42 184 MPI_Comm comm, unsigned flags); \
Chris@42 185 FFTW_EXTERN X(plan) XM(plan_dft_c2r_3d) \
Chris@42 186 (ptrdiff_t n0, ptrdiff_t n1, ptrdiff_t n2, C *in, R *out, \
Chris@42 187 MPI_Comm comm, unsigned flags); \
Chris@42 188 \
Chris@42 189 FFTW_EXTERN void XM(gather_wisdom)(MPI_Comm comm_); \
Chris@42 190 FFTW_EXTERN void XM(broadcast_wisdom)(MPI_Comm comm_); \
Chris@42 191 \
Chris@42 192 FFTW_EXTERN void XM(execute_dft)(X(plan) p, C *in, C *out); \
Chris@42 193 FFTW_EXTERN void XM(execute_dft_r2c)(X(plan) p, R *in, C *out); \
Chris@42 194 FFTW_EXTERN void XM(execute_dft_c2r)(X(plan) p, C *in, R *out); \
Chris@42 195 FFTW_EXTERN void XM(execute_r2r)(X(plan) p, R *in, R *out);
Chris@42 196
Chris@42 197
Chris@42 198
Chris@42 199 /* end of FFTW_MPI_DEFINE_API macro */
Chris@42 200
Chris@42 201 #define FFTW_MPI_MANGLE_DOUBLE(name) FFTW_MANGLE_DOUBLE(FFTW_CONCAT(mpi_,name))
Chris@42 202 #define FFTW_MPI_MANGLE_FLOAT(name) FFTW_MANGLE_FLOAT(FFTW_CONCAT(mpi_,name))
Chris@42 203 #define FFTW_MPI_MANGLE_LONG_DOUBLE(name) FFTW_MANGLE_LONG_DOUBLE(FFTW_CONCAT(mpi_,name))
Chris@42 204
Chris@42 205 FFTW_MPI_DEFINE_API(FFTW_MPI_MANGLE_DOUBLE, FFTW_MANGLE_DOUBLE, double, fftw_complex)
Chris@42 206 FFTW_MPI_DEFINE_API(FFTW_MPI_MANGLE_FLOAT, FFTW_MANGLE_FLOAT, float, fftwf_complex)
Chris@42 207 FFTW_MPI_DEFINE_API(FFTW_MPI_MANGLE_LONG_DOUBLE, FFTW_MANGLE_LONG_DOUBLE, long double, fftwl_complex)
Chris@42 208
Chris@42 209 #define FFTW_MPI_DEFAULT_BLOCK (0)
Chris@42 210
Chris@42 211 /* MPI-specific flags */
Chris@42 212 #define FFTW_MPI_SCRAMBLED_IN (1U << 27)
Chris@42 213 #define FFTW_MPI_SCRAMBLED_OUT (1U << 28)
Chris@42 214 #define FFTW_MPI_TRANSPOSED_IN (1U << 29)
Chris@42 215 #define FFTW_MPI_TRANSPOSED_OUT (1U << 30)
Chris@42 216
Chris@42 217 #ifdef __cplusplus
Chris@42 218 } /* extern "C" */
Chris@42 219 #endif /* __cplusplus */
Chris@42 220
Chris@42 221 #endif /* FFTW3_MPI_H */