annotate src/fftw-3.3.5/rdft/rdft.h @ 42:2cd0e3b3e1fd

Current fftw source
author Chris Cannam
date Tue, 18 Oct 2016 13:40:26 +0100
parents
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 * This program is free software; you can redistribute it and/or modify
Chris@42 6 * it under the terms of the GNU General Public License as published by
Chris@42 7 * the Free Software Foundation; either version 2 of the License, or
Chris@42 8 * (at your option) any later version.
Chris@42 9 *
Chris@42 10 * This program is distributed in the hope that it will be useful,
Chris@42 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@42 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@42 13 * GNU General Public License for more details.
Chris@42 14 *
Chris@42 15 * You should have received a copy of the GNU General Public License
Chris@42 16 * along with this program; if not, write to the Free Software
Chris@42 17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Chris@42 18 *
Chris@42 19 */
Chris@42 20
Chris@42 21 #ifndef __RDFT_H__
Chris@42 22 #define __RDFT_H__
Chris@42 23
Chris@42 24 #include "ifftw.h"
Chris@42 25 #include "codelet-rdft.h"
Chris@42 26
Chris@42 27 #ifdef __cplusplus
Chris@42 28 extern "C"
Chris@42 29 {
Chris@42 30 #endif /* __cplusplus */
Chris@42 31
Chris@42 32 /* problem.c: */
Chris@42 33 typedef struct {
Chris@42 34 problem super;
Chris@42 35 tensor *sz, *vecsz;
Chris@42 36 R *I, *O;
Chris@42 37 #if defined(STRUCT_HACK_KR)
Chris@42 38 rdft_kind kind[1];
Chris@42 39 #elif defined(STRUCT_HACK_C99)
Chris@42 40 rdft_kind kind[];
Chris@42 41 #else
Chris@42 42 rdft_kind *kind;
Chris@42 43 #endif
Chris@42 44 } problem_rdft;
Chris@42 45
Chris@42 46 void X(rdft_zerotens)(tensor *sz, R *I);
Chris@42 47 problem *X(mkproblem_rdft)(const tensor *sz, const tensor *vecsz,
Chris@42 48 R *I, R *O, const rdft_kind *kind);
Chris@42 49 problem *X(mkproblem_rdft_d)(tensor *sz, tensor *vecsz,
Chris@42 50 R *I, R *O, const rdft_kind *kind);
Chris@42 51 problem *X(mkproblem_rdft_0_d)(tensor *vecsz, R *I, R *O);
Chris@42 52 problem *X(mkproblem_rdft_1)(const tensor *sz, const tensor *vecsz,
Chris@42 53 R *I, R *O, rdft_kind kind);
Chris@42 54 problem *X(mkproblem_rdft_1_d)(tensor *sz, tensor *vecsz,
Chris@42 55 R *I, R *O, rdft_kind kind);
Chris@42 56
Chris@42 57 const char *X(rdft_kind_str)(rdft_kind kind);
Chris@42 58
Chris@42 59 /* solve.c: */
Chris@42 60 void X(rdft_solve)(const plan *ego_, const problem *p_);
Chris@42 61
Chris@42 62 /* plan.c: */
Chris@42 63 typedef void (*rdftapply) (const plan *ego, R *I, R *O);
Chris@42 64
Chris@42 65 typedef struct {
Chris@42 66 plan super;
Chris@42 67 rdftapply apply;
Chris@42 68 } plan_rdft;
Chris@42 69
Chris@42 70 plan *X(mkplan_rdft)(size_t size, const plan_adt *adt, rdftapply apply);
Chris@42 71
Chris@42 72 #define MKPLAN_RDFT(type, adt, apply) \
Chris@42 73 (type *)X(mkplan_rdft)(sizeof(type), adt, apply)
Chris@42 74
Chris@42 75 /* various solvers */
Chris@42 76
Chris@42 77 solver *X(mksolver_rdft_r2c_direct)(kr2c k, const kr2c_desc *desc);
Chris@42 78 solver *X(mksolver_rdft_r2c_directbuf)(kr2c k, const kr2c_desc *desc);
Chris@42 79 solver *X(mksolver_rdft_r2r_direct)(kr2r k, const kr2r_desc *desc);
Chris@42 80
Chris@42 81 void X(rdft_rank0_register)(planner *p);
Chris@42 82 void X(rdft_vrank3_transpose_register)(planner *p);
Chris@42 83 void X(rdft_rank_geq2_register)(planner *p);
Chris@42 84 void X(rdft_indirect_register)(planner *p);
Chris@42 85 void X(rdft_vrank_geq1_register)(planner *p);
Chris@42 86 void X(rdft_buffered_register)(planner *p);
Chris@42 87 void X(rdft_generic_register)(planner *p);
Chris@42 88 void X(rdft_rader_hc2hc_register)(planner *p);
Chris@42 89 void X(rdft_dht_register)(planner *p);
Chris@42 90 void X(dht_r2hc_register)(planner *p);
Chris@42 91 void X(dht_rader_register)(planner *p);
Chris@42 92 void X(dft_r2hc_register)(planner *p);
Chris@42 93 void X(rdft_nop_register)(planner *p);
Chris@42 94 void X(hc2hc_generic_register)(planner *p);
Chris@42 95
Chris@42 96 /****************************************************************************/
Chris@42 97 /* problem2.c: */
Chris@42 98 /*
Chris@42 99 An RDFT2 problem transforms a 1d real array r[n] with stride is/os
Chris@42 100 to/from an "unpacked" complex array {rio,iio}[n/2 + 1] with stride
Chris@42 101 os/is. R0 points to the first even element of the real array.
Chris@42 102 R1 points to the first odd element of the real array.
Chris@42 103
Chris@42 104 Strides on the real side of the transform express distances
Chris@42 105 between consecutive elements of the same array (even or odd).
Chris@42 106 E.g., for a contiguous input
Chris@42 107
Chris@42 108 R0 R1 R2 R3 ...
Chris@42 109
Chris@42 110 the input stride would be 2, not 1. This convention is necessary
Chris@42 111 for hc2c codelets to work, since they transpose even/odd with
Chris@42 112 real/imag.
Chris@42 113
Chris@42 114 Multidimensional transforms use complex DFTs for the
Chris@42 115 noncontiguous dimensions. vecsz has the usual interpretation.
Chris@42 116 */
Chris@42 117 typedef struct {
Chris@42 118 problem super;
Chris@42 119 tensor *sz;
Chris@42 120 tensor *vecsz;
Chris@42 121 R *r0, *r1;
Chris@42 122 R *cr, *ci;
Chris@42 123 rdft_kind kind; /* assert(kind < DHT) */
Chris@42 124 } problem_rdft2;
Chris@42 125
Chris@42 126 problem *X(mkproblem_rdft2)(const tensor *sz, const tensor *vecsz,
Chris@42 127 R *r0, R *r1, R *cr, R *ci, rdft_kind kind);
Chris@42 128 problem *X(mkproblem_rdft2_d)(tensor *sz, tensor *vecsz,
Chris@42 129 R *r0, R *r1, R *cr, R *ci, rdft_kind kind);
Chris@42 130 problem *X(mkproblem_rdft2_d_3pointers)(tensor *sz, tensor *vecsz,
Chris@42 131 R *r, R *cr, R *ci, rdft_kind kind);
Chris@42 132 int X(rdft2_inplace_strides)(const problem_rdft2 *p, int vdim);
Chris@42 133 INT X(rdft2_tensor_max_index)(const tensor *sz, rdft_kind k);
Chris@42 134 void X(rdft2_strides)(rdft_kind kind, const iodim *d, INT *rs, INT *cs);
Chris@42 135 INT X(rdft2_complex_n)(INT real_n, rdft_kind kind);
Chris@42 136
Chris@42 137 /* verify.c: */
Chris@42 138 void X(rdft2_verify)(plan *pln, const problem_rdft2 *p, int rounds);
Chris@42 139
Chris@42 140 /* solve.c: */
Chris@42 141 void X(rdft2_solve)(const plan *ego_, const problem *p_);
Chris@42 142
Chris@42 143 /* plan.c: */
Chris@42 144 typedef void (*rdft2apply) (const plan *ego, R *r0, R *r1, R *cr, R *ci);
Chris@42 145
Chris@42 146 typedef struct {
Chris@42 147 plan super;
Chris@42 148 rdft2apply apply;
Chris@42 149 } plan_rdft2;
Chris@42 150
Chris@42 151 plan *X(mkplan_rdft2)(size_t size, const plan_adt *adt, rdft2apply apply);
Chris@42 152
Chris@42 153 #define MKPLAN_RDFT2(type, adt, apply) \
Chris@42 154 (type *)X(mkplan_rdft2)(sizeof(type), adt, apply)
Chris@42 155
Chris@42 156 /* various solvers */
Chris@42 157
Chris@42 158 solver *X(mksolver_rdft2_direct)(kr2c k, const kr2c_desc *desc);
Chris@42 159
Chris@42 160 void X(rdft2_vrank_geq1_register)(planner *p);
Chris@42 161 void X(rdft2_buffered_register)(planner *p);
Chris@42 162 void X(rdft2_rdft_register)(planner *p);
Chris@42 163 void X(rdft2_nop_register)(planner *p);
Chris@42 164 void X(rdft2_rank0_register)(planner *p);
Chris@42 165 void X(rdft2_rank_geq2_register)(planner *p);
Chris@42 166
Chris@42 167 /****************************************************************************/
Chris@42 168
Chris@42 169 /* configurations */
Chris@42 170 void X(rdft_conf_standard)(planner *p);
Chris@42 171
Chris@42 172 #ifdef __cplusplus
Chris@42 173 } /* extern "C" */
Chris@42 174 #endif /* __cplusplus */
Chris@42 175
Chris@42 176 #endif /* __RDFT_H__ */