Chris@82: /*
Chris@82:  * Copyright (c) 2003, 2007-14 Matteo Frigo
Chris@82:  * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
Chris@82:  *
Chris@82:  * This program is free software; you can redistribute it and/or modify
Chris@82:  * it under the terms of the GNU General Public License as published by
Chris@82:  * the Free Software Foundation; either version 2 of the License, or
Chris@82:  * (at your option) any later version.
Chris@82:  *
Chris@82:  * This program is distributed in the hope that it will be useful,
Chris@82:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@82:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@82:  * GNU General Public License for more details.
Chris@82:  *
Chris@82:  * You should have received a copy of the GNU General Public License
Chris@82:  * along with this program; if not, write to the Free Software
Chris@82:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
Chris@82:  *
Chris@82:  */
Chris@82: 
Chris@82: #ifndef __RDFT_H__
Chris@82: #define __RDFT_H__
Chris@82: 
Chris@82: #include "kernel/ifftw.h"
Chris@82: #include "rdft/codelet-rdft.h"
Chris@82: 
Chris@82: #ifdef __cplusplus
Chris@82: extern "C"
Chris@82: {
Chris@82: #endif /* __cplusplus */
Chris@82: 
Chris@82: /* problem.c: */
Chris@82: typedef struct {
Chris@82:      problem super;
Chris@82:      tensor *sz, *vecsz;
Chris@82:      R *I, *O;
Chris@82: #if defined(STRUCT_HACK_KR)
Chris@82:      rdft_kind kind[1];
Chris@82: #elif defined(STRUCT_HACK_C99)
Chris@82:      rdft_kind kind[];
Chris@82: #else
Chris@82:      rdft_kind *kind;
Chris@82: #endif
Chris@82: } problem_rdft;
Chris@82: 
Chris@82: void X(rdft_zerotens)(tensor *sz, R *I);
Chris@82: problem *X(mkproblem_rdft)(const tensor *sz, const tensor *vecsz,
Chris@82: 			   R *I, R *O, const rdft_kind *kind);
Chris@82: problem *X(mkproblem_rdft_d)(tensor *sz, tensor *vecsz,
Chris@82: 			     R *I, R *O, const rdft_kind *kind);
Chris@82: problem *X(mkproblem_rdft_0_d)(tensor *vecsz, R *I, R *O);
Chris@82: problem *X(mkproblem_rdft_1)(const tensor *sz, const tensor *vecsz,
Chris@82: 			     R *I, R *O, rdft_kind kind);
Chris@82: problem *X(mkproblem_rdft_1_d)(tensor *sz, tensor *vecsz,
Chris@82: 			       R *I, R *O, rdft_kind kind);
Chris@82: 
Chris@82: const char *X(rdft_kind_str)(rdft_kind kind);
Chris@82: 
Chris@82: /* solve.c: */
Chris@82: void X(rdft_solve)(const plan *ego_, const problem *p_);
Chris@82: 
Chris@82: /* plan.c: */
Chris@82: typedef void (*rdftapply) (const plan *ego, R *I, R *O);
Chris@82: 
Chris@82: typedef struct {
Chris@82:      plan super;
Chris@82:      rdftapply apply;
Chris@82: } plan_rdft;
Chris@82: 
Chris@82: plan *X(mkplan_rdft)(size_t size, const plan_adt *adt, rdftapply apply);
Chris@82: 
Chris@82: #define MKPLAN_RDFT(type, adt, apply) \
Chris@82:   (type *)X(mkplan_rdft)(sizeof(type), adt, apply)
Chris@82: 
Chris@82: /* various solvers */
Chris@82: 
Chris@82: solver *X(mksolver_rdft_r2c_direct)(kr2c k, const kr2c_desc *desc);
Chris@82: solver *X(mksolver_rdft_r2c_directbuf)(kr2c k, const kr2c_desc *desc);
Chris@82: solver *X(mksolver_rdft_r2r_direct)(kr2r k, const kr2r_desc *desc);
Chris@82: 
Chris@82: void X(rdft_rank0_register)(planner *p);
Chris@82: void X(rdft_vrank3_transpose_register)(planner *p);
Chris@82: void X(rdft_rank_geq2_register)(planner *p);
Chris@82: void X(rdft_indirect_register)(planner *p);
Chris@82: void X(rdft_vrank_geq1_register)(planner *p);
Chris@82: void X(rdft_buffered_register)(planner *p);
Chris@82: void X(rdft_generic_register)(planner *p);
Chris@82: void X(rdft_rader_hc2hc_register)(planner *p);
Chris@82: void X(rdft_dht_register)(planner *p);
Chris@82: void X(dht_r2hc_register)(planner *p);
Chris@82: void X(dht_rader_register)(planner *p);
Chris@82: void X(dft_r2hc_register)(planner *p);
Chris@82: void X(rdft_nop_register)(planner *p);
Chris@82: void X(hc2hc_generic_register)(planner *p);
Chris@82: 
Chris@82: /****************************************************************************/
Chris@82: /* problem2.c: */
Chris@82: /* 
Chris@82:    An RDFT2 problem transforms a 1d real array r[n] with stride is/os
Chris@82:    to/from an "unpacked" complex array {rio,iio}[n/2 + 1] with stride
Chris@82:    os/is.  R0 points to the first even element of the real array.  
Chris@82:    R1 points to the first odd element of the real array.
Chris@82: 
Chris@82:    Strides on the real side of the transform express distances
Chris@82:    between consecutive elements of the same array (even or odd).
Chris@82:    E.g., for a contiguous input
Chris@82: 
Chris@82:      R0 R1 R2 R3 ...
Chris@82: 
Chris@82:    the input stride would be 2, not 1.  This convention is necessary
Chris@82:    for hc2c codelets to work, since they transpose even/odd with
Chris@82:    real/imag.
Chris@82:    
Chris@82:    Multidimensional transforms use complex DFTs for the
Chris@82:    noncontiguous dimensions.  vecsz has the usual interpretation.  
Chris@82: */
Chris@82: typedef struct {
Chris@82:      problem super;
Chris@82:      tensor *sz;
Chris@82:      tensor *vecsz;
Chris@82:      R *r0, *r1;
Chris@82:      R *cr, *ci;
Chris@82:      rdft_kind kind; /* assert(kind < DHT) */
Chris@82: } problem_rdft2;
Chris@82: 
Chris@82: problem *X(mkproblem_rdft2)(const tensor *sz, const tensor *vecsz,
Chris@82: 			    R *r0, R *r1, R *cr, R *ci, rdft_kind kind);
Chris@82: problem *X(mkproblem_rdft2_d)(tensor *sz, tensor *vecsz,
Chris@82: 			      R *r0, R *r1, R *cr, R *ci, rdft_kind kind);
Chris@82: problem *X(mkproblem_rdft2_d_3pointers)(tensor *sz, tensor *vecsz,
Chris@82: 					R *r, R *cr, R *ci, rdft_kind kind);
Chris@82: int X(rdft2_inplace_strides)(const problem_rdft2 *p, int vdim);
Chris@82: INT X(rdft2_tensor_max_index)(const tensor *sz, rdft_kind k);
Chris@82: void X(rdft2_strides)(rdft_kind kind, const iodim *d, INT *rs, INT *cs);
Chris@82: INT X(rdft2_complex_n)(INT real_n, rdft_kind kind);
Chris@82: 
Chris@82: /* verify.c: */
Chris@82: void X(rdft2_verify)(plan *pln, const problem_rdft2 *p, int rounds);
Chris@82: 
Chris@82: /* solve.c: */
Chris@82: void X(rdft2_solve)(const plan *ego_, const problem *p_);
Chris@82: 
Chris@82: /* plan.c: */
Chris@82: typedef void (*rdft2apply) (const plan *ego, R *r0, R *r1, R *cr, R *ci);
Chris@82: 
Chris@82: typedef struct {
Chris@82:      plan super;
Chris@82:      rdft2apply apply;
Chris@82: } plan_rdft2;
Chris@82: 
Chris@82: plan *X(mkplan_rdft2)(size_t size, const plan_adt *adt, rdft2apply apply);
Chris@82: 
Chris@82: #define MKPLAN_RDFT2(type, adt, apply) \
Chris@82:   (type *)X(mkplan_rdft2)(sizeof(type), adt, apply)
Chris@82: 
Chris@82: /* various solvers */
Chris@82: 
Chris@82: solver *X(mksolver_rdft2_direct)(kr2c k, const kr2c_desc *desc);
Chris@82: 
Chris@82: void X(rdft2_vrank_geq1_register)(planner *p);
Chris@82: void X(rdft2_buffered_register)(planner *p);
Chris@82: void X(rdft2_rdft_register)(planner *p);
Chris@82: void X(rdft2_nop_register)(planner *p);
Chris@82: void X(rdft2_rank0_register)(planner *p);
Chris@82: void X(rdft2_rank_geq2_register)(planner *p);
Chris@82: 
Chris@82: /****************************************************************************/
Chris@82: 
Chris@82: /* configurations */
Chris@82: void X(rdft_conf_standard)(planner *p);
Chris@82: 
Chris@82: #ifdef __cplusplus
Chris@82: }  /* extern "C" */
Chris@82: #endif /* __cplusplus */
Chris@82: 
Chris@82: #endif /* __RDFT_H__ */