htswanalysis/MACS/lib/gsl/gsl-1.11/wavelet/gsl_wavelet.h

   1 /* wavelet/gsl_wavelet.h
   2  *
   3  * Copyright (C) 2004 Ivo Alxneit
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or (at
   8  * your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef __GSL_WAVELET_H__
  21 #define __GSL_WAVELET_H__
  22 #include <stdlib.h>
  23 #include <gsl/gsl_types.h>
  24 #include <gsl/gsl_errno.h>
  25
  26 #undef __BEGIN_DECLS
  27 #undef __END_DECLS
  28 #ifdef __cplusplus
  29 # define __BEGIN_DECLS extern "C" {
  30 # define __END_DECLS }
  31 #else
  32 # define __BEGIN_DECLS          /* empty */
  33 # define __END_DECLS            /* empty */
  34 #endif
  35
  36 __BEGIN_DECLS
  37
  38 #ifndef GSL_DISABLE_DEPRECATED
  39 typedef enum {
  40   forward = 1, backward = -1,
  41   gsl_wavelet_forward = 1, gsl_wavelet_backward = -1
  42 }
  43 gsl_wavelet_direction;
  44 #else
  45 typedef enum {
  46   gsl_wavelet_forward = 1, gsl_wavelet_backward = -1
  47 }
  48 gsl_wavelet_direction;
  49 #endif
  50
  51 typedef struct
  52 {
  53   const char *name;
  54   int (*init) (const double **h1, const double **g1,
  55                const double **h2, const double **g2, size_t * nc,
  56                size_t * offset, size_t member);
  57 }
  58 gsl_wavelet_type;
  59
  60 typedef struct
  61 {
  62   const gsl_wavelet_type *type;
  63   const double *h1;
  64   const double *g1;
  65   const double *h2;
  66   const double *g2;
  67   size_t nc;
  68   size_t offset;
  69 }
  70 gsl_wavelet;
  71
  72 typedef struct
  73 {
  74   double *scratch;
  75   size_t n;
  76 }
  77 gsl_wavelet_workspace;
  78
  79 GSL_VAR const gsl_wavelet_type *gsl_wavelet_daubechies;
  80 GSL_VAR const gsl_wavelet_type *gsl_wavelet_daubechies_centered;
  81 GSL_VAR const gsl_wavelet_type *gsl_wavelet_haar;
  82 GSL_VAR const gsl_wavelet_type *gsl_wavelet_haar_centered;
  83 GSL_VAR const gsl_wavelet_type *gsl_wavelet_bspline;
  84 GSL_VAR const gsl_wavelet_type *gsl_wavelet_bspline_centered;
  85
  86 gsl_wavelet *gsl_wavelet_alloc (const gsl_wavelet_type * T, size_t k);
  87 void gsl_wavelet_free (gsl_wavelet * w);
  88 const char *gsl_wavelet_name (const gsl_wavelet * w);
  89
  90 gsl_wavelet_workspace *gsl_wavelet_workspace_alloc (size_t n);
  91 void gsl_wavelet_workspace_free (gsl_wavelet_workspace * work);
  92
  93 int gsl_wavelet_transform (const gsl_wavelet * w,
  94                            double *data, size_t stride, size_t n,
  95                            gsl_wavelet_direction dir,
  96                            gsl_wavelet_workspace * work);
  97
  98 int gsl_wavelet_transform_forward (const gsl_wavelet * w,
  99                                    double *data, size_t stride, size_t n,
 100                                    gsl_wavelet_workspace * work);
 101
 102 int gsl_wavelet_transform_inverse (const gsl_wavelet * w,
 103                                     double *data, size_t stride, size_t n,
 104                                     gsl_wavelet_workspace * work);
 105
 106 __END_DECLS
 107
 108 #endif /* __GSL_WAVELET_H__ */