htswanalysis/MACS/lib/gsl/gsl-1.11/multifit/gsl_multifit_nlin.h

   1 /* multifit_nlin/gsl_multifit_nlin.h
   2  *
   3  * Copyright (C) 1996, 1997, 1998, 1999, 2000, 2007 Brian Gough
   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_MULTIFIT_NLIN_H__
  21 #define __GSL_MULTIFIT_NLIN_H__
  22
  23 #include <stdlib.h>
  24 #include <gsl/gsl_types.h>
  25 #include <gsl/gsl_math.h>
  26 #include <gsl/gsl_vector.h>
  27 #include <gsl/gsl_matrix.h>
  28
  29 #undef __BEGIN_DECLS
  30 #undef __END_DECLS
  31 #ifdef __cplusplus
  32 # define __BEGIN_DECLS extern "C" {
  33 # define __END_DECLS }
  34 #else
  35 # define __BEGIN_DECLS /* empty */
  36 # define __END_DECLS /* empty */
  37 #endif
  38
  39 __BEGIN_DECLS
  40
  41 int gsl_multifit_gradient (const gsl_matrix * J, const gsl_vector * f,
  42                            gsl_vector * g);
  43
  44 int gsl_multifit_covar (const gsl_matrix * J, double epsrel, gsl_matrix * covar);
  45
  46
  47 /* Definition of vector-valued functions with parameters based on gsl_vector */
  48
  49 struct gsl_multifit_function_struct
  50 {
  51   int (* f) (const gsl_vector * x, void * params, gsl_vector * f);
  52   size_t n;   /* number of functions */
  53   size_t p;   /* number of independent variables */
  54   void * params;
  55 };
  56
  57 typedef struct gsl_multifit_function_struct gsl_multifit_function ;
  58
  59 #define GSL_MULTIFIT_FN_EVAL(F,x,y) (*((F)->f))(x,(F)->params,(y))
  60
  61 typedef struct
  62   {
  63     const char *name;
  64     size_t size;
  65     int (*alloc) (void *state, size_t n, size_t p);
  66     int (*set) (void *state, gsl_multifit_function * function, gsl_vector * x, gsl_vector * f, gsl_vector * dx);
  67     int (*iterate) (void *state, gsl_multifit_function * function, gsl_vector * x, gsl_vector * f, gsl_vector * dx);
  68     void (*free) (void *state);
  69   }
  70 gsl_multifit_fsolver_type;
  71
  72 typedef struct
  73   {
  74     const gsl_multifit_fsolver_type * type;
  75     gsl_multifit_function * function ;
  76     gsl_vector * x ;
  77     gsl_vector * f ;
  78     gsl_vector * dx ;
  79     void *state;
  80   }
  81 gsl_multifit_fsolver;
  82
  83 gsl_multifit_fsolver *
  84 gsl_multifit_fsolver_alloc (const gsl_multifit_fsolver_type * T,
  85                             size_t n, size_t p);
  86
  87 void gsl_multifit_fsolver_free (gsl_multifit_fsolver * s);
  88
  89 int gsl_multifit_fsolver_set (gsl_multifit_fsolver * s,
  90                                    gsl_multifit_function * f,
  91                                    const gsl_vector * x);
  92
  93 int gsl_multifit_fsolver_iterate (gsl_multifit_fsolver * s);
  94
  95 const char * gsl_multifit_fsolver_name (const gsl_multifit_fsolver * s);
  96 gsl_vector * gsl_multifit_fsolver_position (const gsl_multifit_fsolver * s);
  97
  98 /* Definition of vector-valued functions and gradient with parameters
  99    based on gsl_vector */
 100
 101 struct gsl_multifit_function_fdf_struct
 102 {
 103   int (* f) (const gsl_vector * x, void * params, gsl_vector * f);
 104   int (* df) (const gsl_vector * x, void * params, gsl_matrix * df);
 105   int (* fdf) (const gsl_vector * x, void * params, gsl_vector * f, gsl_matrix *df);
 106   size_t n;   /* number of functions */
 107   size_t p;   /* number of independent variables */
 108   void * params;
 109 };
 110
 111 typedef struct gsl_multifit_function_fdf_struct gsl_multifit_function_fdf ;
 112
 113 #define GSL_MULTIFIT_FN_EVAL_F(F,x,y) ((*((F)->f))(x,(F)->params,(y)))
 114 #define GSL_MULTIFIT_FN_EVAL_DF(F,x,dy) ((*((F)->df))(x,(F)->params,(dy)))
 115 #define GSL_MULTIFIT_FN_EVAL_F_DF(F,x,y,dy) ((*((F)->fdf))(x,(F)->params,(y),(dy)))
 116
 117 typedef struct
 118   {
 119     const char *name;
 120     size_t size;
 121     int (*alloc) (void *state, size_t n, size_t p);
 122     int (*set) (void *state, gsl_multifit_function_fdf * fdf, gsl_vector * x, gsl_vector * f, gsl_matrix * J, gsl_vector * dx);
 123     int (*iterate) (void *state, gsl_multifit_function_fdf * fdf, gsl_vector * x, gsl_vector * f, gsl_matrix * J, gsl_vector * dx);
 124     void (*free) (void *state);
 125   }
 126 gsl_multifit_fdfsolver_type;
 127
 128 typedef struct
 129   {
 130     const gsl_multifit_fdfsolver_type * type;
 131     gsl_multifit_function_fdf * fdf ;
 132     gsl_vector * x;
 133     gsl_vector * f;
 134     gsl_matrix * J;
 135     gsl_vector * dx;
 136     void *state;
 137   }
 138 gsl_multifit_fdfsolver;
 139
 140
 141 gsl_multifit_fdfsolver *
 142 gsl_multifit_fdfsolver_alloc (const gsl_multifit_fdfsolver_type * T,
 143                               size_t n, size_t p);
 144
 145 int
 146 gsl_multifit_fdfsolver_set (gsl_multifit_fdfsolver * s,
 147                                  gsl_multifit_function_fdf * fdf,
 148                                  const gsl_vector * x);
 149
 150 int
 151 gsl_multifit_fdfsolver_iterate (gsl_multifit_fdfsolver * s);
 152
 153 void
 154 gsl_multifit_fdfsolver_free (gsl_multifit_fdfsolver * s);
 155
 156 const char * gsl_multifit_fdfsolver_name (const gsl_multifit_fdfsolver * s);
 157 gsl_vector * gsl_multifit_fdfsolver_position (const gsl_multifit_fdfsolver * s);
 158
 159 int gsl_multifit_test_delta (const gsl_vector * dx, const gsl_vector * x,
 160                              double epsabs, double epsrel);
 161
 162 int gsl_multifit_test_gradient (const gsl_vector * g, double epsabs);
 163
 164 /* extern const gsl_multifit_fsolver_type * gsl_multifit_fsolver_gradient; */
 165
 166 GSL_VAR const gsl_multifit_fdfsolver_type * gsl_multifit_fdfsolver_lmder;
 167 GSL_VAR const gsl_multifit_fdfsolver_type * gsl_multifit_fdfsolver_lmsder;
 168
 169
 170 __END_DECLS
 171
 172 #endif /* __GSL_MULTIFIT_NLIN_H__ */