|
Packit |
67cb25 |
/* multiroots/gsl_multiroots.h
|
|
Packit |
67cb25 |
*
|
|
Packit |
67cb25 |
* Copyright (C) 1996, 1997, 1998, 1999, 2000, 2007 Brian Gough
|
|
Packit |
67cb25 |
*
|
|
Packit |
67cb25 |
* This program is free software; you can redistribute it and/or modify
|
|
Packit |
67cb25 |
* it under the terms of the GNU General Public License as published by
|
|
Packit |
67cb25 |
* the Free Software Foundation; either version 3 of the License, or (at
|
|
Packit |
67cb25 |
* your option) any later version.
|
|
Packit |
67cb25 |
*
|
|
Packit |
67cb25 |
* This program is distributed in the hope that it will be useful, but
|
|
Packit |
67cb25 |
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
Packit |
67cb25 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Packit |
67cb25 |
* General Public License for more details.
|
|
Packit |
67cb25 |
*
|
|
Packit |
67cb25 |
* You should have received a copy of the GNU General Public License
|
|
Packit |
67cb25 |
* along with this program; if not, write to the Free Software
|
|
Packit |
67cb25 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
Packit |
67cb25 |
*/
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
#ifndef __GSL_MULTIROOTS_H__
|
|
Packit |
67cb25 |
#define __GSL_MULTIROOTS_H__
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
#include <stdlib.h>
|
|
Packit |
67cb25 |
#include <gsl/gsl_types.h>
|
|
Packit |
67cb25 |
#include <gsl/gsl_math.h>
|
|
Packit |
67cb25 |
#include <gsl/gsl_vector.h>
|
|
Packit |
67cb25 |
#include <gsl/gsl_matrix.h>
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
#undef __BEGIN_DECLS
|
|
Packit |
67cb25 |
#undef __END_DECLS
|
|
Packit |
67cb25 |
#ifdef __cplusplus
|
|
Packit |
67cb25 |
# define __BEGIN_DECLS extern "C" {
|
|
Packit |
67cb25 |
# define __END_DECLS }
|
|
Packit |
67cb25 |
#else
|
|
Packit |
67cb25 |
# define __BEGIN_DECLS /* empty */
|
|
Packit |
67cb25 |
# define __END_DECLS /* empty */
|
|
Packit |
67cb25 |
#endif
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
__BEGIN_DECLS
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
/* Definition of vector-valued functions with parameters based on gsl_vector */
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
struct gsl_multiroot_function_struct
|
|
Packit |
67cb25 |
{
|
|
Packit |
67cb25 |
int (* f) (const gsl_vector * x, void * params, gsl_vector * f);
|
|
Packit |
67cb25 |
size_t n;
|
|
Packit |
67cb25 |
void * params;
|
|
Packit |
67cb25 |
};
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
typedef struct gsl_multiroot_function_struct gsl_multiroot_function ;
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
#define GSL_MULTIROOT_FN_EVAL(F,x,y) (*((F)->f))(x,(F)->params,(y))
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
int gsl_multiroot_fdjacobian (gsl_multiroot_function * F,
|
|
Packit |
67cb25 |
const gsl_vector * x, const gsl_vector * f,
|
|
Packit |
67cb25 |
double epsrel, gsl_matrix * jacobian);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
typedef struct
|
|
Packit |
67cb25 |
{
|
|
Packit |
67cb25 |
const char *name;
|
|
Packit |
67cb25 |
size_t size;
|
|
Packit |
67cb25 |
int (*alloc) (void *state, size_t n);
|
|
Packit |
67cb25 |
int (*set) (void *state, gsl_multiroot_function * function, gsl_vector * x, gsl_vector * f, gsl_vector * dx);
|
|
Packit |
67cb25 |
int (*iterate) (void *state, gsl_multiroot_function * function, gsl_vector * x, gsl_vector * f, gsl_vector * dx);
|
|
Packit |
67cb25 |
void (*free) (void *state);
|
|
Packit |
67cb25 |
}
|
|
Packit |
67cb25 |
gsl_multiroot_fsolver_type;
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
typedef struct
|
|
Packit |
67cb25 |
{
|
|
Packit |
67cb25 |
const gsl_multiroot_fsolver_type * type;
|
|
Packit |
67cb25 |
gsl_multiroot_function * function ;
|
|
Packit |
67cb25 |
gsl_vector * x ;
|
|
Packit |
67cb25 |
gsl_vector * f ;
|
|
Packit |
67cb25 |
gsl_vector * dx ;
|
|
Packit |
67cb25 |
void *state;
|
|
Packit |
67cb25 |
}
|
|
Packit |
67cb25 |
gsl_multiroot_fsolver;
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
gsl_multiroot_fsolver *
|
|
Packit |
67cb25 |
gsl_multiroot_fsolver_alloc (const gsl_multiroot_fsolver_type * T,
|
|
Packit |
67cb25 |
size_t n);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
void gsl_multiroot_fsolver_free (gsl_multiroot_fsolver * s);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
int gsl_multiroot_fsolver_set (gsl_multiroot_fsolver * s,
|
|
Packit |
67cb25 |
gsl_multiroot_function * f,
|
|
Packit |
67cb25 |
const gsl_vector * x);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
int gsl_multiroot_fsolver_iterate (gsl_multiroot_fsolver * s);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
const char * gsl_multiroot_fsolver_name (const gsl_multiroot_fsolver * s);
|
|
Packit |
67cb25 |
gsl_vector * gsl_multiroot_fsolver_root (const gsl_multiroot_fsolver * s);
|
|
Packit |
67cb25 |
gsl_vector * gsl_multiroot_fsolver_dx (const gsl_multiroot_fsolver * s);
|
|
Packit |
67cb25 |
gsl_vector * gsl_multiroot_fsolver_f (const gsl_multiroot_fsolver * s);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
/* Definition of vector-valued functions and gradient with parameters
|
|
Packit |
67cb25 |
based on gsl_vector */
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
struct gsl_multiroot_function_fdf_struct
|
|
Packit |
67cb25 |
{
|
|
Packit |
67cb25 |
int (* f) (const gsl_vector * x, void * params, gsl_vector * f);
|
|
Packit |
67cb25 |
int (* df) (const gsl_vector * x, void * params, gsl_matrix * df);
|
|
Packit |
67cb25 |
int (* fdf) (const gsl_vector * x, void * params, gsl_vector * f, gsl_matrix *df);
|
|
Packit |
67cb25 |
size_t n;
|
|
Packit |
67cb25 |
void * params;
|
|
Packit |
67cb25 |
};
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
typedef struct gsl_multiroot_function_fdf_struct gsl_multiroot_function_fdf ;
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
#define GSL_MULTIROOT_FN_EVAL_F(F,x,y) ((*((F)->f))(x,(F)->params,(y)))
|
|
Packit |
67cb25 |
#define GSL_MULTIROOT_FN_EVAL_DF(F,x,dy) ((*((F)->df))(x,(F)->params,(dy)))
|
|
Packit |
67cb25 |
#define GSL_MULTIROOT_FN_EVAL_F_DF(F,x,y,dy) ((*((F)->fdf))(x,(F)->params,(y),(dy)))
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
typedef struct
|
|
Packit |
67cb25 |
{
|
|
Packit |
67cb25 |
const char *name;
|
|
Packit |
67cb25 |
size_t size;
|
|
Packit |
67cb25 |
int (*alloc) (void *state, size_t n);
|
|
Packit |
67cb25 |
int (*set) (void *state, gsl_multiroot_function_fdf * fdf, gsl_vector * x, gsl_vector * f, gsl_matrix * J, gsl_vector * dx);
|
|
Packit |
67cb25 |
int (*iterate) (void *state, gsl_multiroot_function_fdf * fdf, gsl_vector * x, gsl_vector * f, gsl_matrix * J, gsl_vector * dx);
|
|
Packit |
67cb25 |
void (*free) (void *state);
|
|
Packit |
67cb25 |
}
|
|
Packit |
67cb25 |
gsl_multiroot_fdfsolver_type;
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
typedef struct
|
|
Packit |
67cb25 |
{
|
|
Packit |
67cb25 |
const gsl_multiroot_fdfsolver_type * type;
|
|
Packit |
67cb25 |
gsl_multiroot_function_fdf * fdf ;
|
|
Packit |
67cb25 |
gsl_vector * x;
|
|
Packit |
67cb25 |
gsl_vector * f;
|
|
Packit |
67cb25 |
gsl_matrix * J;
|
|
Packit |
67cb25 |
gsl_vector * dx;
|
|
Packit |
67cb25 |
void *state;
|
|
Packit |
67cb25 |
}
|
|
Packit |
67cb25 |
gsl_multiroot_fdfsolver;
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
gsl_multiroot_fdfsolver *
|
|
Packit |
67cb25 |
gsl_multiroot_fdfsolver_alloc (const gsl_multiroot_fdfsolver_type * T,
|
|
Packit |
67cb25 |
size_t n);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
int
|
|
Packit |
67cb25 |
gsl_multiroot_fdfsolver_set (gsl_multiroot_fdfsolver * s,
|
|
Packit |
67cb25 |
gsl_multiroot_function_fdf * fdf,
|
|
Packit |
67cb25 |
const gsl_vector * x);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
int
|
|
Packit |
67cb25 |
gsl_multiroot_fdfsolver_iterate (gsl_multiroot_fdfsolver * s);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
void
|
|
Packit |
67cb25 |
gsl_multiroot_fdfsolver_free (gsl_multiroot_fdfsolver * s);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
const char * gsl_multiroot_fdfsolver_name (const gsl_multiroot_fdfsolver * s);
|
|
Packit |
67cb25 |
gsl_vector * gsl_multiroot_fdfsolver_root (const gsl_multiroot_fdfsolver * s);
|
|
Packit |
67cb25 |
gsl_vector * gsl_multiroot_fdfsolver_dx (const gsl_multiroot_fdfsolver * s);
|
|
Packit |
67cb25 |
gsl_vector * gsl_multiroot_fdfsolver_f (const gsl_multiroot_fdfsolver * s);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
int gsl_multiroot_test_delta (const gsl_vector * dx, const gsl_vector * x,
|
|
Packit |
67cb25 |
double epsabs, double epsrel);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
int gsl_multiroot_test_residual (const gsl_vector * f, double epsabs);
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
GSL_VAR const gsl_multiroot_fsolver_type * gsl_multiroot_fsolver_dnewton;
|
|
Packit |
67cb25 |
GSL_VAR const gsl_multiroot_fsolver_type * gsl_multiroot_fsolver_broyden;
|
|
Packit |
67cb25 |
GSL_VAR const gsl_multiroot_fsolver_type * gsl_multiroot_fsolver_hybrid;
|
|
Packit |
67cb25 |
GSL_VAR const gsl_multiroot_fsolver_type * gsl_multiroot_fsolver_hybrids;
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
GSL_VAR const gsl_multiroot_fdfsolver_type * gsl_multiroot_fdfsolver_newton;
|
|
Packit |
67cb25 |
GSL_VAR const gsl_multiroot_fdfsolver_type * gsl_multiroot_fdfsolver_gnewton;
|
|
Packit |
67cb25 |
GSL_VAR const gsl_multiroot_fdfsolver_type * gsl_multiroot_fdfsolver_hybridj;
|
|
Packit |
67cb25 |
GSL_VAR const gsl_multiroot_fdfsolver_type * gsl_multiroot_fdfsolver_hybridsj;
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
__END_DECLS
|
|
Packit |
67cb25 |
|
|
Packit |
67cb25 |
#endif /* __GSL_MULTIROOTS_H__ */
|