/usr/include/gsl/gsl_multifit_nlin.h is in libgsl-dev 2.3+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 | /* multifit_nlin/gsl_multifit_nlin.h
*
* Copyright (C) 1996, 1997, 1998, 1999, 2000, 2007 Brian Gough
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __GSL_MULTIFIT_NLIN_H__
#define __GSL_MULTIFIT_NLIN_H__
#include <stdlib.h>
#include <gsl/gsl_types.h>
#include <gsl/gsl_math.h>
#include <gsl/gsl_vector.h>
#include <gsl/gsl_matrix.h>
#include <gsl/gsl_permutation.h>
#undef __BEGIN_DECLS
#undef __END_DECLS
#ifdef __cplusplus
# define __BEGIN_DECLS extern "C" {
# define __END_DECLS }
#else
# define __BEGIN_DECLS /* empty */
# define __END_DECLS /* empty */
#endif
__BEGIN_DECLS
int gsl_multifit_gradient (const gsl_matrix * J, const gsl_vector * f,
gsl_vector * g);
int gsl_multifit_covar (const gsl_matrix * J, const double epsrel, gsl_matrix * covar);
int gsl_multifit_covar_QRPT (gsl_matrix * r, gsl_permutation * perm,
const double epsrel, gsl_matrix * covar);
/* Definition of vector-valued functions with parameters based on gsl_vector */
struct gsl_multifit_function_struct
{
int (* f) (const gsl_vector * x, void * params, gsl_vector * f);
size_t n; /* number of functions */
size_t p; /* number of independent variables */
void * params;
};
typedef struct gsl_multifit_function_struct gsl_multifit_function ;
#define GSL_MULTIFIT_FN_EVAL(F,x,y) (*((F)->f))(x,(F)->params,(y))
typedef struct
{
const char *name;
size_t size;
int (*alloc) (void *state, size_t n, size_t p);
int (*set) (void *state, gsl_multifit_function * function, gsl_vector * x, gsl_vector * f, gsl_vector * dx);
int (*iterate) (void *state, gsl_multifit_function * function, gsl_vector * x, gsl_vector * f, gsl_vector * dx);
void (*free) (void *state);
}
gsl_multifit_fsolver_type;
typedef struct
{
const gsl_multifit_fsolver_type * type;
gsl_multifit_function * function ;
gsl_vector * x ;
gsl_vector * f ;
gsl_vector * dx ;
void *state;
}
gsl_multifit_fsolver;
gsl_multifit_fsolver *
gsl_multifit_fsolver_alloc (const gsl_multifit_fsolver_type * T,
size_t n, size_t p);
void gsl_multifit_fsolver_free (gsl_multifit_fsolver * s);
int gsl_multifit_fsolver_set (gsl_multifit_fsolver * s,
gsl_multifit_function * f,
const gsl_vector * x);
int gsl_multifit_fsolver_iterate (gsl_multifit_fsolver * s);
int gsl_multifit_fsolver_driver (gsl_multifit_fsolver * s,
const size_t maxiter,
const double epsabs, const double epsrel);
const char * gsl_multifit_fsolver_name (const gsl_multifit_fsolver * s);
gsl_vector * gsl_multifit_fsolver_position (const gsl_multifit_fsolver * s);
/* Definition of vector-valued functions and gradient with parameters
based on gsl_vector */
struct gsl_multifit_function_fdf_struct
{
int (* f) (const gsl_vector * x, void * params, gsl_vector * f);
int (* df) (const gsl_vector * x, void * params, gsl_matrix * df);
int (* fdf) (const gsl_vector * x, void * params, gsl_vector * f, gsl_matrix *df);
size_t n; /* number of functions */
size_t p; /* number of independent variables */
void * params; /* user parameters */
size_t nevalf; /* number of function evaluations */
size_t nevaldf; /* number of Jacobian evaluations */
};
typedef struct gsl_multifit_function_fdf_struct gsl_multifit_function_fdf ;
typedef struct
{
const char *name;
size_t size;
int (*alloc) (void *state, size_t n, size_t p);
int (*set) (void *state, const gsl_vector * wts,
gsl_multifit_function_fdf * fdf, gsl_vector * x,
gsl_vector * f, gsl_vector * dx);
int (*iterate) (void *state, const gsl_vector * wts,
gsl_multifit_function_fdf * fdf, gsl_vector * x,
gsl_vector * f, gsl_vector * dx);
int (*gradient) (void *state, gsl_vector * g);
int (*jac) (void *state, gsl_matrix * J);
void (*free) (void *state);
}
gsl_multifit_fdfsolver_type;
typedef struct
{
const gsl_multifit_fdfsolver_type * type;
gsl_multifit_function_fdf * fdf ;
gsl_vector * x; /* parameter values x */
gsl_vector * f; /* residual vector f(x) */
gsl_vector * dx; /* step dx */
gsl_vector * g; /* gradient J^T f */
gsl_vector * sqrt_wts; /* sqrt(wts) */
size_t niter; /* number of iterations performed */
void *state;
}
gsl_multifit_fdfsolver;
gsl_multifit_fdfsolver *
gsl_multifit_fdfsolver_alloc (const gsl_multifit_fdfsolver_type * T,
size_t n, size_t p);
int
gsl_multifit_fdfsolver_set (gsl_multifit_fdfsolver * s,
gsl_multifit_function_fdf * fdf,
const gsl_vector * x);
int gsl_multifit_fdfsolver_wset (gsl_multifit_fdfsolver * s,
gsl_multifit_function_fdf * f,
const gsl_vector * x,
const gsl_vector * wts);
int
gsl_multifit_fdfsolver_iterate (gsl_multifit_fdfsolver * s);
int gsl_multifit_fdfsolver_driver (gsl_multifit_fdfsolver * s,
const size_t maxiter,
const double xtol,
const double gtol,
const double ftol,
int *info);
int gsl_multifit_fdfsolver_jac (gsl_multifit_fdfsolver * s,
gsl_matrix * J);
void
gsl_multifit_fdfsolver_free (gsl_multifit_fdfsolver * s);
const char * gsl_multifit_fdfsolver_name (const gsl_multifit_fdfsolver * s);
gsl_vector * gsl_multifit_fdfsolver_position (const gsl_multifit_fdfsolver * s);
gsl_vector * gsl_multifit_fdfsolver_residual (const gsl_multifit_fdfsolver * s);
size_t gsl_multifit_fdfsolver_niter (const gsl_multifit_fdfsolver * s);
int gsl_multifit_eval_wf(gsl_multifit_function_fdf *fdf,
const gsl_vector *x, const gsl_vector *wts,
gsl_vector *y);
int gsl_multifit_eval_wdf(gsl_multifit_function_fdf *fdf,
const gsl_vector *x, const gsl_vector *wts,
gsl_matrix *dy);
int gsl_multifit_fdfsolver_test (const gsl_multifit_fdfsolver * s,
const double xtol,
const double gtol,
const double ftol, int *info);
int gsl_multifit_test_delta (const gsl_vector * dx, const gsl_vector * x,
double epsabs, double epsrel);
int gsl_multifit_test_gradient (const gsl_vector * g, double epsabs);
int gsl_multifit_fdfsolver_dif_df(const gsl_vector *x,
const gsl_vector *wts,
gsl_multifit_function_fdf *fdf,
const gsl_vector *f, gsl_matrix *J);
int gsl_multifit_fdfsolver_dif_fdf(const gsl_vector *x, gsl_multifit_function_fdf *fdf,
gsl_vector *f, gsl_matrix *J);
typedef struct
{
size_t n; /* number of (original) residuals */
size_t p; /* number of model parameters */
double lambda; /* damping parameter */
const gsl_vector *L_diag; /* diagonal damping matrix or NULL */
const gsl_matrix *L; /* general damping matrix or NULL */
gsl_vector *f; /* function values for finite diff J */
gsl_vector *wts; /* weight vector for augmented system */
gsl_multifit_fdfsolver * s;
gsl_multifit_function_fdf *fdf; /* user defined fdf */
gsl_multifit_function_fdf fdftik; /* Tikhonov modified fdf */
} gsl_multifit_fdfridge;
gsl_multifit_fdfridge *
gsl_multifit_fdfridge_alloc (const gsl_multifit_fdfsolver_type * T,
const size_t n, const size_t p);
void gsl_multifit_fdfridge_free(gsl_multifit_fdfridge *work);
const char *gsl_multifit_fdfridge_name(const gsl_multifit_fdfridge * w);
gsl_vector *gsl_multifit_fdfridge_position (const gsl_multifit_fdfridge * w);
gsl_vector *gsl_multifit_fdfridge_residual (const gsl_multifit_fdfridge * w);
size_t gsl_multifit_fdfridge_niter (const gsl_multifit_fdfridge * w);
int gsl_multifit_fdfridge_set (gsl_multifit_fdfridge * w,
gsl_multifit_function_fdf * f,
const gsl_vector * x,
const double lambda);
int gsl_multifit_fdfridge_wset (gsl_multifit_fdfridge * w,
gsl_multifit_function_fdf * f,
const gsl_vector * x,
const double lambda,
const gsl_vector * wts);
int gsl_multifit_fdfridge_set2 (gsl_multifit_fdfridge * w,
gsl_multifit_function_fdf * f,
const gsl_vector * x,
const gsl_vector * lambda);
int gsl_multifit_fdfridge_wset2 (gsl_multifit_fdfridge * w,
gsl_multifit_function_fdf * f,
const gsl_vector * x,
const gsl_vector * lambda,
const gsl_vector * wts);
int gsl_multifit_fdfridge_set3 (gsl_multifit_fdfridge * w,
gsl_multifit_function_fdf * f,
const gsl_vector * x,
const gsl_matrix * L);
int gsl_multifit_fdfridge_wset3 (gsl_multifit_fdfridge * w,
gsl_multifit_function_fdf * f,
const gsl_vector * x,
const gsl_matrix * L,
const gsl_vector * wts);
int gsl_multifit_fdfridge_iterate (gsl_multifit_fdfridge * w);
int gsl_multifit_fdfridge_driver (gsl_multifit_fdfridge * w,
const size_t maxiter,
const double xtol,
const double gtol,
const double ftol,
int *info);
/* extern const gsl_multifit_fsolver_type * gsl_multifit_fsolver_gradient; */
GSL_VAR const gsl_multifit_fdfsolver_type * gsl_multifit_fdfsolver_lmsder;
GSL_VAR const gsl_multifit_fdfsolver_type * gsl_multifit_fdfsolver_lmder;
GSL_VAR const gsl_multifit_fdfsolver_type * gsl_multifit_fdfsolver_lmniel;
__END_DECLS
#endif /* __GSL_MULTIFIT_NLIN_H__ */
|