Mercurial > hg > sv-dependency-builds

annotate src/fftw-3.3.8/mpi/fftw3-mpi.h @ 83:ae30d91d2ffe

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