include/gsl/gsl_fft_complex_float.h

0001 /* fft/gsl_fft_complex_float.h
0002  *
0003  * Copyright (C) 1996, 1997, 1998, 1999, 2000, 2007 Brian Gough
0004  *
0005  * This program is free software; you can redistribute it and/or modify
0006  * it under the terms of the GNU General Public License as published by
0007  * the Free Software Foundation; either version 3 of the License, or (at
0008  * your option) any later version.
0009  *
0010  * This program is distributed in the hope that it will be useful, but
0011  * WITHOUT ANY WARRANTY; without even the implied warranty of
0012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0013  * General Public License for more details.
0014  *
0015  * You should have received a copy of the GNU General Public License
0016  * along with this program; if not, write to the Free Software
0017  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
0018  */
0019
0020 #ifndef __GSL_FFT_COMPLEX_FLOAT_H__
0021 #define __GSL_FFT_COMPLEX_FLOAT_H__
0022
0023 #include <stddef.h>
0024
0025 #include <gsl/gsl_math.h>
0026 #include <gsl/gsl_complex.h>
0027 #include <gsl/gsl_fft.h>
0028
0029 #undef __BEGIN_DECLS
0030 #undef __END_DECLS
0031 #ifdef __cplusplus
0032 # define __BEGIN_DECLS extern "C" {
0033 # define __END_DECLS }
0034 #else
0035 # define __BEGIN_DECLS /* empty */
0036 # define __END_DECLS /* empty */
0037 #endif
0038
0039 __BEGIN_DECLS
0040
0041 /*  Power of 2 routines  */
0042
0043
0044 int gsl_fft_complex_float_radix2_forward (gsl_complex_packed_array_float data,
0045                                           const size_t stride,
0046                                           const size_t n);
0047
0048 int gsl_fft_complex_float_radix2_backward (gsl_complex_packed_array_float data,
0049                                            const size_t stride,
0050                                            const size_t n);
0051
0052 int gsl_fft_complex_float_radix2_inverse (gsl_complex_packed_array_float data,
0053                                           const size_t stride,
0054                                           const size_t n);
0055
0056 int gsl_fft_complex_float_radix2_transform (gsl_complex_packed_array_float data,
0057                                             const size_t stride,
0058                                             const size_t n,
0059                                             const gsl_fft_direction sign);
0060
0061 int gsl_fft_complex_float_radix2_dif_forward (gsl_complex_packed_array_float data,
0062                                               const size_t stride,
0063                                               const size_t n);
0064
0065 int gsl_fft_complex_float_radix2_dif_backward (gsl_complex_packed_array_float data,
0066                                                const size_t stride,
0067                                                const size_t n);
0068
0069 int gsl_fft_complex_float_radix2_dif_inverse (gsl_complex_packed_array_float data,
0070                                               const size_t stride,
0071                                               const size_t n);
0072
0073 int gsl_fft_complex_float_radix2_dif_transform (gsl_complex_packed_array_float data,
0074                                                 const size_t stride,
0075                                                 const size_t n,
0076                                                 const gsl_fft_direction sign);
0077
0078 /*  Mixed Radix general-N routines  */
0079
0080 typedef struct
0081   {
0082     size_t n;
0083     size_t nf;
0084     size_t factor[64];
0085     gsl_complex_float *twiddle[64];
0086     gsl_complex_float *trig;
0087   }
0088 gsl_fft_complex_wavetable_float;
0089
0090 typedef struct
0091 {
0092     size_t n;
0093     float *scratch;
0094 }
0095 gsl_fft_complex_workspace_float;
0096
0097
0098 gsl_fft_complex_wavetable_float *gsl_fft_complex_wavetable_float_alloc (size_t n);
0099
0100 void gsl_fft_complex_wavetable_float_free (gsl_fft_complex_wavetable_float * wavetable);
0101
0102 gsl_fft_complex_workspace_float *gsl_fft_complex_workspace_float_alloc (size_t n);
0103
0104 void gsl_fft_complex_workspace_float_free (gsl_fft_complex_workspace_float * workspace);
0105
0106
0107 int gsl_fft_complex_float_memcpy (gsl_fft_complex_wavetable_float * dest,
0108                                gsl_fft_complex_wavetable_float * src);
0109
0110
0111 int gsl_fft_complex_float_forward (gsl_complex_packed_array_float data,
0112                                    const size_t stride,
0113                                    const size_t n,
0114                                    const gsl_fft_complex_wavetable_float * wavetable,
0115                                    gsl_fft_complex_workspace_float * work);
0116
0117 int gsl_fft_complex_float_backward (gsl_complex_packed_array_float data,
0118                                     const size_t stride,
0119                                     const size_t n,
0120                                     const gsl_fft_complex_wavetable_float * wavetable,
0121                                     gsl_fft_complex_workspace_float * work);
0122
0123 int gsl_fft_complex_float_inverse (gsl_complex_packed_array_float data,
0124                                    const size_t stride,
0125                                    const size_t n,
0126                                    const gsl_fft_complex_wavetable_float * wavetable,
0127                                    gsl_fft_complex_workspace_float * work);
0128
0129 int gsl_fft_complex_float_transform (gsl_complex_packed_array_float data,
0130                                      const size_t stride, const size_t n,
0131                                      const gsl_fft_complex_wavetable_float * wavetable,
0132                                      gsl_fft_complex_workspace_float * work,
0133                                      const gsl_fft_direction sign);
0134
0135 __END_DECLS
0136
0137 #endif /* __GSL_FFT_COMPLEX_FLOAT_H__ */
0138
0139