cannam@167: /*
cannam@167:  * Copyright (c) 2003, 2007-14 Matteo Frigo
cannam@167:  * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
cannam@167:  *
cannam@167:  * This program is free software; you can redistribute it and/or modify
cannam@167:  * it under the terms of the GNU General Public License as published by
cannam@167:  * the Free Software Foundation; either version 2 of the License, or
cannam@167:  * (at your option) any later version.
cannam@167:  *
cannam@167:  * This program is distributed in the hope that it will be useful,
cannam@167:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@167:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cannam@167:  * GNU General Public License for more details.
cannam@167:  *
cannam@167:  * You should have received a copy of the GNU General Public License
cannam@167:  * along with this program; if not, write to the Free Software
cannam@167:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
cannam@167:  *
cannam@167:  */
cannam@167: 
cannam@167: /* internal API definitions */
cannam@167: #ifndef __API_H__
cannam@167: #define __API_H__
cannam@167: 
cannam@167: #ifndef CALLING_FFTW /* defined in hook.c, when calling internal functions */
cannam@167: #  define COMPILING_FFTW /* used for DLL symbol exporting in fftw3.h */
cannam@167: #endif
cannam@167: 
cannam@167: /* When compiling with GNU libtool on Windows, DLL_EXPORT is #defined
cannam@167:    for compiling the shared-library code.  In this case, we'll #define
cannam@167:    FFTW_DLL to add dllexport attributes to the specified functions in
cannam@167:    fftw3.h.
cannam@167: 
cannam@167:    If we don't specify dllexport explicitly, then libtool
cannam@167:    automatically exports all symbols.  However, if we specify
cannam@167:    dllexport explicitly for any functions, then libtool apparently
cannam@167:    doesn't do any automatic exporting.  (Not documented, grrr, but
cannam@167:    this is the observed behavior with libtool 1.5.8.)  Thus, using
cannam@167:    this forces us to correctly dllexport every exported symbol, or
cannam@167:    linking bench.exe will fail.  This has the advantage of forcing
cannam@167:    us to mark things correctly, which is necessary for other compilers
cannam@167:    (such as MS VC++). */
cannam@167: #ifdef DLL_EXPORT
cannam@167: #  define FFTW_DLL
cannam@167: #endif
cannam@167: 
cannam@167: /* just in case: force <fftw3.h> not to use C99 complex numbers
cannam@167:    (we need this for IBM xlc because _Complex_I is treated specially
cannam@167:    and is defined even if <complex.h> is not included) */
cannam@167: #define FFTW_NO_Complex
cannam@167: 
cannam@167: #include "api/fftw3.h"
cannam@167: #include "kernel/ifftw.h"
cannam@167: #include "rdft/rdft.h"
cannam@167: 
cannam@167: #ifdef __cplusplus
cannam@167: extern "C"
cannam@167: {
cannam@167: #endif /* __cplusplus */
cannam@167: 
cannam@167: /* the API ``plan'' contains both the kernel plan and problem */
cannam@167: struct X(plan_s) {
cannam@167:      plan *pln;
cannam@167:      problem *prb;
cannam@167:      int sign;
cannam@167: };
cannam@167: 
cannam@167: /* shorthand */
cannam@167: typedef struct X(plan_s) apiplan;
cannam@167: 
cannam@167: /* complex type for internal use */
cannam@167: typedef R C[2];
cannam@167: 
cannam@167: #define EXTRACT_REIM(sign, c, r, i) X(extract_reim)(sign, (c)[0], r, i)
cannam@167: 
cannam@167: #define TAINT_UNALIGNED(p, flg) TAINT(p, ((flg) & FFTW_UNALIGNED) != 0)
cannam@167: 
cannam@167: tensor *X(mktensor_rowmajor)(int rnk, const int *n,
cannam@167: 			     const int *niphys, const int *nophys,
cannam@167: 			     int is, int os);
cannam@167: 
cannam@167: tensor *X(mktensor_iodims)(int rank, const X(iodim) *dims, int is, int os);
cannam@167: tensor *X(mktensor_iodims64)(int rank, const X(iodim64) *dims, int is, int os);
cannam@167: const int *X(rdft2_pad)(int rnk, const int *n, const int *nembed,
cannam@167: 			int inplace, int cmplx, int **nfree);
cannam@167: 
cannam@167: int X(many_kosherp)(int rnk, const int *n, int howmany);
cannam@167: int X(guru_kosherp)(int rank, const X(iodim) *dims,
cannam@167: 		    int howmany_rank, const X(iodim) *howmany_dims);
cannam@167: int X(guru64_kosherp)(int rank, const X(iodim64) *dims,
cannam@167: 		    int howmany_rank, const X(iodim64) *howmany_dims);
cannam@167: 
cannam@167: /* Note: FFTW_EXTERN is used for "internal" functions used in tests/hook.c */
cannam@167: 
cannam@167: FFTW_EXTERN printer *X(mkprinter_file)(FILE *f);
cannam@167: 
cannam@167: printer *X(mkprinter_cnt)(size_t *cnt);
cannam@167: printer *X(mkprinter_str)(char *s);
cannam@167: 
cannam@167: FFTW_EXTERN planner *X(the_planner)(void);
cannam@167: void X(configure_planner)(planner *plnr);
cannam@167: 
cannam@167: void X(mapflags)(planner *, unsigned);
cannam@167: 
cannam@167: apiplan *X(mkapiplan)(int sign, unsigned flags, problem *prb);
cannam@167: 
cannam@167: rdft_kind *X(map_r2r_kind)(int rank, const X(r2r_kind) * kind);
cannam@167: 
cannam@167: typedef void (*planner_hook_t)(void);
cannam@167:                                                      
cannam@167: void X(set_planner_hooks)(planner_hook_t before, planner_hook_t after);
cannam@167: 
cannam@167: #ifdef __cplusplus
cannam@167: }  /* extern "C" */
cannam@167: #endif /* __cplusplus */
cannam@167: 
cannam@167: #endif				/* __API_H__ */