Namespace for gsl_multifit_nlinear functions. More...

Classes
class	CallbackBase
	You can create callbacks as a subclass of this class. More...

class	function_fdf
	Class that extends gsl_multifit_nlinear_fdf so that it can be constructed from arbitrary function objects. More...

class	workspace
	Workspace for nonlinear linear least squares fitting. More...

Typedefs
typedef void(*	driver_callback) (const size_t iter, void params, gsl_multifit_nlinear_workspace const w)
	Function pointer for use by driver. More...

Functions
gsl_multifit_nlinear_parameters	default_parameters ()
	C++ version of gsl_multifit_nlinear_default_parameters(). More...

int	init (vector const &x, gsl::multifit::nlinear::function_fdf &fdf, workspace &w)
	C++ version of gsl_multifit_nlinear_init(). More...

int	winit (vector const &x, vector const &wts, gsl::multifit::nlinear::function_fdf &fdf, workspace &w)
	C++ version of gsl_multifit_nlinear_winit(). More...

int	iterate (workspace &w)
	C++ version of gsl_multifit_nlinear_iterate(). More...

double	avratio (workspace const &w)
	C++ version of gsl_multifit_nlinear_avratio(). More...

int	driver (size_t const maxiter, double const xtol, double const gtol, double const ftol, CallbackBase &callback, int &info, workspace &w)
	C++ version of gsl_multifit_nlinear_driver(). More...

int	driver (size_t const maxiter, double const xtol, double const gtol, double const ftol, driver_callback callback, void callback_params, int info, workspace &w)
	C++ version of gsl_multifit_nlinear_driver(). More...

matrix	jac (workspace const &w)
	C++ version of gsl_multifit_nlinear_jac(). More...

char const *	name (workspace const &w)
	C++ version of gsl_multifit_nlinear_name(). More...

vector	position (workspace const &w)
	C++ version of gsl_multifit_nlinear_position(). More...

vector	residual (workspace const &w)
	C++ version of gsl_multifit_nlinear_residual(). More...

size_t	niter (workspace const &w)
	C++ version of gsl_multifit_nlinear_niter(). More...

int	rcond (double &rcond, workspace const &w)
	C++ version of gsl_multifit_nlinear_rcond(). More...

int	rcond (double *rcond, workspace const &w)
	C++ version of gsl_multifit_nlinear_rcond(). More...

char const *	trs_name (workspace const &w)
	C++ version of gsl_multifit_nlinear_trs_name(). More...

int	eval_f (gsl::multifit::nlinear::function_fdf &fdf, vector const &x, vector const &swts, vector &y)
	C++ version of gsl_multifit_nlinear_eval_f(). More...

int	eval_df (vector const &x, vector const &f, vector const &swts, double const h, gsl_multifit_nlinear_fdtype const fdtype, gsl::multifit::nlinear::function_fdf &fdf, matrix &df, vector &work)
	C++ version of gsl_multifit_nlinear_eval_df(). More...

int	eval_fvv (double const h, vector const &x, vector const &v, vector const &f, matrix const &J, vector const &swts, gsl::multifit::nlinear::function_fdf &fdf, vector &yvv, vector &work)
	C++ version of gsl_multifit_nlinear_eval_fvv(). More...

int	covar (matrix const &J, double const epsrel, matrix &covar)
	C++ version of gsl_multifit_nlinear_covar(). More...

int	test (double const xtol, double const gtol, double const ftol, int *info, workspace const &w)
	C++ version of gsl_multifit_nlinear_test(). More...

int	test (double const xtol, double const gtol, double const ftol, int &info, workspace const &w)
	C++ version of gsl_multifit_nlinear_test(). More...

int	df (double const h, gsl_multifit_nlinear_fdtype const fdtype, vector const &x, vector const &wts, gsl::multifit::nlinear::function_fdf &fdf, vector const &f, matrix &J, vector &work)
	C++ version of gsl_multifit_nlinear_df(). More...

int	fdfvv (double const h, vector const &x, vector const &v, vector const &f, matrix const &J, vector const &swts, gsl::multifit::nlinear::function_fdf &fdf, vector &fvv, vector &work)
	C++ version of gsl_multifit_nlinear_fdfvv(). More...

template<typename T >
void	function_constructor (function_fdf &f, T &t)

template<typename T >
function_fdf	make_function_fdf (T &t)
	Make a gsl::multifit::nlinear::function_fdf from a function object that implements gsl::multifit::nlinear::function_fdf::concept. More...

Detailed Description

Namespace for gsl_multifit_nlinear functions.

Typedef Documentation

◆ driver_callback

typedef void(* gsl::multifit::nlinear::driver_callback) (const size_t iter, void *params, gsl_multifit_nlinear_workspace const *w)

Function pointer for use by driver.

Definition at line 497 of file multifit_nlinear.hpp.

Function Documentation

◆ avratio()

double gsl::multifit::nlinear::avratio ( workspace const & w )

inline

C++ version of gsl_multifit_nlinear_avratio().

Parameters

w	The workspace

Returns: GSL_SUCCESS or error code on failure

Definition at line 468 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ covar()

int gsl::multifit::nlinear::covar	(	matrix const &	J,
		double const	epsrel,
		matrix &	covar
	)

inline

C++ version of gsl_multifit_nlinear_covar().

Parameters

J	The Jacobian matrix
epsrel	Relative error
covar	The covariance matrix of the best-fit parameters [return]

Returns: GSL_SUCCESS or error code on failure

Definition at line 652 of file multifit_nlinear.hpp.

References covar(), and gsl::matrix::get().

Referenced by covar().

◆ default_parameters()

gsl_multifit_nlinear_parameters gsl::multifit::nlinear::default_parameters ( )

inline

C++ version of gsl_multifit_nlinear_default_parameters().

Returns: A default set of parameters

Definition at line 430 of file multifit_nlinear.hpp.

◆ df()

int gsl::multifit::nlinear::df	(	double const	h,
		gsl_multifit_nlinear_fdtype const	fdtype,
		vector const &	x,
		vector const &	wts,
		gsl::multifit::nlinear::function_fdf &	fdf,
		vector const &	f,
		matrix &	J,
		vector &	work
	)

inline

C++ version of gsl_multifit_nlinear_df().

Parameters

h	a constant
fdtype	A type
x	A vector
wts	A weight vector
fdf	The sytem of functions
f	A vector
J	A matrix [return]
work	Work vector

Returns: GSL_SUCCESS or error code on failure

Definition at line 695 of file multifit_nlinear.hpp.

References gsl::matrix::get(), and gsl::vector::get().

Referenced by eval_df(), gsl::fn_fdf_eval_df(), gsl::function_fdf::function_fdf(), gsl::multifit::nlinear::function_fdf::function_fdf(), gsl::multimin::function_fdf::function_fdf(), gsl::multiroot::function_fdf::function_fdf(), gsl::function_fdf::operator=(), gsl::multifit::nlinear::function_fdf::operator=(), gsl::multimin::function_fdf::operator=(), and gsl::multiroot::function_fdf::operator=().

◆ driver() [1/2]

int gsl::multifit::nlinear::driver	(	size_t const	maxiter,
		double const	xtol,
		double const	gtol,
		double const	ftol,
		CallbackBase &	callback,
		int &	info,
		workspace &	w
	)

inline

C++ version of gsl_multifit_nlinear_driver().

Use a subclass of Callback to save or print values of variables at each iteration.

Parameters

maxiter	Maximum number of iterations
xtol	Error tolerance
gtol	Error tolerance
ftol	Error tolerance
callback	An object of a subclass of CallbackBase
info	GSL_SUCCESS or an error code [return]
w	A workspace

Returns: GSL_SUCCESS, GSL_MAXITER or GSL_ENOPROG

Definition at line 482 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ driver() [2/2]

int gsl::multifit::nlinear::driver	(	size_t const	maxiter,
		double const	xtol,
		double const	gtol,
		double const	ftol,
		driver_callback	callback,
		void *	callback_params,
		int *	info,
		workspace &	w
	)

inline

C++ version of gsl_multifit_nlinear_driver().

Parameters

maxiter	Maximum number of iterations
xtol	Error tolerance
gtol	Error tolerance
ftol	Error tolerance
callback	A callback function
callback_params	parameters for the callback function
info	GSL_SUCCESS or an error code [return]
w	A workspace

Returns: GSL_SUCCESS, GSL_MAXITER or GSL_ENOPROG

Definition at line 512 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ eval_df()

int gsl::multifit::nlinear::eval_df	(	vector const &	x,
		vector const &	f,
		vector const &	swts,
		double const	h,
		gsl_multifit_nlinear_fdtype const	fdtype,
		gsl::multifit::nlinear::function_fdf &	fdf,
		matrix &	df,
		vector &	work
	)

inline

C++ version of gsl_multifit_nlinear_eval_df().

Parameters

x	A vector
f	A vector
swts	A weight vector
h	a constant
fdtype	A type
fdf	The sytem of functions
df	return matrix
work	Work matrix

Returns: GSL_SUCCESS or error code on failure

Definition at line 617 of file multifit_nlinear.hpp.

References df(), and gsl::vector::get().

◆ eval_f()

int gsl::multifit::nlinear::eval_f	(	gsl::multifit::nlinear::function_fdf &	fdf,
		vector const &	x,
		vector const &	swts,
		vector &	y
	)

inline

C++ version of gsl_multifit_nlinear_eval_f().

Parameters

fdf	The sytem of functions
x	A vector
swts	A weight vector
y	The return vector

Returns: GSL_SUCCESS or error code on failure

Definition at line 601 of file multifit_nlinear.hpp.

References gsl::vector::get().

◆ eval_fvv()

int gsl::multifit::nlinear::eval_fvv	(	double const	h,
		vector const &	x,
		vector const &	v,
		vector const &	f,
		matrix const &	J,
		vector const &	swts,
		gsl::multifit::nlinear::function_fdf &	fdf,
		vector &	yvv,
		vector &	work
	)

inline

C++ version of gsl_multifit_nlinear_eval_fvv().

Parameters

h	a constant
x	A vector
v	A vector
f	A vector
J	A matrix
swts	A weight vector
fdf	The sytem of functions
yvv	A return vector
work	Work matrix

Returns: GSL_SUCCESS or error code on failure

Definition at line 637 of file multifit_nlinear.hpp.

References gsl::matrix::get(), and gsl::vector::get().

◆ fdfvv()

int gsl::multifit::nlinear::fdfvv	(	double const	h,
		vector const &	x,
		vector const &	v,
		vector const &	f,
		matrix const &	J,
		vector const &	swts,
		gsl::multifit::nlinear::function_fdf &	fdf,
		vector &	fvv,
		vector &	work
	)

inline

C++ version of gsl_multifit_nlinear_fdfvv().

Parameters

h	a constant
x	A vector
v	A vector
f	A vector
J	A matrix
swts	A weight vector
fdf	The sytem of functions
fvv	Return vector
work	Work vector

Returns: GSL_SUCCESS or error code on failure

Definition at line 715 of file multifit_nlinear.hpp.

References gsl::matrix::get(), and gsl::vector::get().

◆ function_constructor()

template<typename T >

void gsl::multifit::nlinear::function_constructor	(	function_fdf &	f,
		T &	t
	)

◆ init()

int gsl::multifit::nlinear::init	(	vector const &	x,
		gsl::multifit::nlinear::function_fdf &	fdf,
		workspace &	w
	)

inline

C++ version of gsl_multifit_nlinear_init().

Initialise workspace to use system fdf and the initial guess x.

Parameters

x	Initial guess (vector)
fdf	The sytem of functions
w	The workspace

Returns: GSL_SUCCESS or error code on failure

Definition at line 440 of file multifit_nlinear.hpp.

References gsl::vector::get(), and gsl::multifit::nlinear::workspace::get().

◆ iterate()

int gsl::multifit::nlinear::iterate ( workspace & w )

inline

C++ version of gsl_multifit_nlinear_iterate().

Parameters

w	The workspace

Returns: GSL_SUCCESS or error code on failure

Definition at line 461 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ jac()

matrix gsl::multifit::nlinear::jac ( workspace const & w )

inline

C++ version of gsl_multifit_nlinear_jac().

Parameters

w	The workspace

Returns: The Jacobian matrix of the current iteration of the solver

Definition at line 528 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ make_function_fdf()

template<typename T >

function_fdf gsl::multifit::nlinear::make_function_fdf ( T & t )

inline

Make a gsl::multifit::nlinear::function_fdf from a function object that implements gsl::multifit::nlinear::function_fdf::concept.

Parameters

t	The function object.

Definition at line 578 of file multifit_nlinear_function_fdf.hpp.

◆ name()

char const * gsl::multifit::nlinear::name ( workspace const & w )

inline

C++ version of gsl_multifit_nlinear_name().

Parameters

w	The workspace

Returns: the name of the solver

Definition at line 538 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ niter()

size_t gsl::multifit::nlinear::niter ( workspace const & w )

inline

C++ version of gsl_multifit_nlinear_niter().

Parameters

w	The workspace

Returns: The current number of iterations

Definition at line 565 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ position()

vector gsl::multifit::nlinear::position ( workspace const & w )

inline

C++ version of gsl_multifit_nlinear_position().

Parameters

w	The workspace

Returns: The current position

Definition at line 545 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ rcond() [1/2]

int gsl::multifit::nlinear::rcond	(	double &	rcond,
		workspace const &	w
	)

inline

C++ version of gsl_multifit_nlinear_rcond().

Parameters

rcond	The current reciprocal condition number [return]
w	The workspace

Returns: GSL_SUCCESS or error code on failure

Definition at line 573 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get(), and rcond().

Referenced by gsl::linalg::cholesky_band_rcond(), gsl::linalg::cholesky_rcond(), gsl::linalg::ldlt_band_rcond(), gsl::linalg::ldlt_rcond(), gsl::linalg::mcholesky_rcond(), gsl::linalg::pcholesky_rcond(), gsl::linalg::QR_rcond(), gsl::linalg::QRPT_rcond(), rcond(), gsl::linalg::tri_lower_rcond(), gsl::linalg::tri_rcond(), and gsl::linalg::tri_upper_rcond().

◆ rcond() [2/2]

int gsl::multifit::nlinear::rcond	(	double *	rcond,
		workspace const &	w
	)

inline

C++ version of gsl_multifit_nlinear_rcond().

Parameters

rcond	The current reciprocal condition number [return]
w	The workspace

Returns: GSL_SUCCESS or error code on failure

Definition at line 582 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get(), and rcond().

◆ residual()

vector gsl::multifit::nlinear::residual ( workspace const & w )

inline

C++ version of gsl_multifit_nlinear_residual().

Parameters

w	The workspace

Returns: The current resdiual

Definition at line 555 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

Referenced by gsl::linalg::COD_lssolve(), gsl::linalg::COD_lssolve2(), gsl::linalg::complex_LU_refine(), gsl::linalg::complex_QR_lssolve(), gsl::linalg::LQ_lssolve(), gsl::linalg::LQ_lssolve_T(), gsl::linalg::LU_refine(), gsl::linalg::QR_lssolve(), gsl::linalg::QRPT_lssolve(), and gsl::linalg::QRPT_lssolve2().

◆ test() [1/2]

int gsl::multifit::nlinear::test	(	double const	xtol,
		double const	gtol,
		double const	ftol,
		int &	info,
		workspace const &	w
	)

inline

C++ version of gsl_multifit_nlinear_test().

Parameters

xtol	Tolerance in step size
gtol	Tolerance in gradient
ftol	Tolerance
info	return value: set to zero if no test succeeeds
w	The workspace

Returns: GSL_SUCCESS, GSL_CONTINUE

Definition at line 679 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ test() [2/2]

int gsl::multifit::nlinear::test	(	double const	xtol,
		double const	gtol,
		double const	ftol,
		int *	info,
		workspace const &	w
	)

inline

C++ version of gsl_multifit_nlinear_test().

Parameters

xtol	Tolerance in step size
gtol	Tolerance in gradient
ftol	Tolerance
info	return value: set to zero if no test succeeeds
w	The workspace

Returns: GSL_SUCCESS, GSL_CONTINUE

Definition at line 666 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ trs_name()

char const * gsl::multifit::nlinear::trs_name ( workspace const & w )

inline

C++ version of gsl_multifit_nlinear_trs_name().

Parameters

w	The workspace

Returns: the name of the trust region subproblem method

Definition at line 590 of file multifit_nlinear.hpp.

References gsl::multifit::nlinear::workspace::get().

◆ winit()

int gsl::multifit::nlinear::winit	(	vector const &	x,
		vector const &	wts,
		gsl::multifit::nlinear::function_fdf &	fdf,
		workspace &	w
	)

inline

C++ version of gsl_multifit_nlinear_winit().

Parameters

x	Initial guess (vector)
wts	A weights vector
fdf	The sytem of functions
w	The workspace

Returns: GSL_SUCCESS or error code on failure

Definition at line 452 of file multifit_nlinear.hpp.

References gsl::vector::get(), and gsl::multifit::nlinear::workspace::get().

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ driver_callback

Function Documentation

◆ avratio()

◆ covar()

◆ default_parameters()

◆ df()

◆ driver() [1/2]

◆ driver() [2/2]

◆ eval_df()

◆ eval_f()

◆ eval_fvv()

◆ fdfvv()

◆ function_constructor()

◆ init()

◆ iterate()

◆ jac()

◆ make_function_fdf()

◆ name()

◆ niter()

◆ position()

◆ rcond() [1/2]

◆ rcond() [2/2]

◆ residual()

◆ test() [1/2]

◆ test() [2/2]

◆ trs_name()

◆ winit()