Linear systems. More...

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

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

class	workspace
	Workspace for solving systems. More...

Typedefs
typedef gsl_multilarge_nlinear_type	type
	Typedef for shorthand. More...

typedef gsl_multilarge_nlinear_parameters	parameters
	Typedef for shorthand. More...

typedef gsl_multilarge_nlinear_trs	trs
	Typedef for shorthand. More...

typedef gsl_multilarge_nlinear_scale	scale
	Typedef for shorthand. More...

typedef gsl_multilarge_nlinear_solver	solver
	Typedef for shorthand. More...

typedef gsl_multilarge_nlinear_fdf	fdf
	Typedef for shorthand. More...

typedef gsl_multilarge_nlinear_fdtype	fdtype
	Typedef for shorthand. More...

typedef void(*	driver_callback) (const size_t iter, void params, gsl_multilarge_nlinear_workspace const w)
	Convenient typedef. More...

Functions
parameters	default_parameters ()
	C++ version of gsl_multilarge_nlinear_default_parameters(). More...

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

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

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

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

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

int	covar (matrix &covar, workspace &w)
	C++ version of gsl_multilarge_nlinear_covar(). 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_multilarge_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_multilarge_nlinear_driver(). More...

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

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

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

vector	step (workspace const &w)
	C++ version of gsl_multilarge_nlinear_step(). More...

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

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

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

int	eval_df (CBLAS_TRANSPOSE_t const TransJ, vector const &x, vector const &f, vector const &u, vector const &swts, double const h, fdtype const fdtype, gsl::multilarge::nlinear::function_fdf &fdf, vector &v, matrix &JTJ, vector &work)
	C++ version of gsl_multilarge_nlinear_eval_df(). More...

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

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

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

int	fdfvv (double const h, vector const &x, vector const &v, vector const &f, matrix const &J, vector const &swts, gsl::multilarge::nlinear::function_fdf &fdf, vector &fvv, vector &work)
	C++ version of gsl_multilarge_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::multilarge::nlinear::function_fdf from a function object that implements gsl::multilarge::nlinear::function_fdf::concept. More...

Detailed Description

Linear systems.

Typedef Documentation

◆ driver_callback

typedef void(* gsl::multilarge::nlinear::driver_callback) (const size_t iter, void *params, gsl_multilarge_nlinear_workspace const *w)

Convenient typedef.

Definition at line 624 of file multilarge_nlinear.hpp.

◆ fdf

typedef gsl_multilarge_nlinear_fdf gsl::multilarge::nlinear::fdf

Typedef for shorthand.

Definition at line 114 of file multilarge_nlinear.hpp.

◆ fdtype

typedef gsl_multilarge_nlinear_fdtype gsl::multilarge::nlinear::fdtype

Typedef for shorthand.

Definition at line 118 of file multilarge_nlinear.hpp.

◆ parameters

typedef gsl_multilarge_nlinear_parameters gsl::multilarge::nlinear::parameters

Typedef for shorthand.

Definition at line 48 of file multilarge_nlinear.hpp.

◆ scale

typedef gsl_multilarge_nlinear_scale gsl::multilarge::nlinear::scale

Typedef for shorthand.

Definition at line 56 of file multilarge_nlinear.hpp.

◆ solver

typedef gsl_multilarge_nlinear_solver gsl::multilarge::nlinear::solver

Typedef for shorthand.

Definition at line 60 of file multilarge_nlinear.hpp.

◆ trs

typedef gsl_multilarge_nlinear_trs gsl::multilarge::nlinear::trs

Typedef for shorthand.

Definition at line 52 of file multilarge_nlinear.hpp.

◆ type

typedef gsl_multilarge_nlinear_type gsl::multilarge::nlinear::type

Typedef for shorthand.

Definition at line 38 of file multilarge_nlinear.hpp.

Function Documentation

◆ avratio()

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

inline

C++ version of gsl_multilarge_nlinear_avratio().

Parameters

w	A gsl::multilarge::nlinear workspace

Returns: Current ration of acceleration correction term to velocity step term

Definition at line 578 of file multilarge_nlinear.hpp.

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

◆ covar()

int gsl::multilarge::nlinear::covar	(	matrix &	covar,
		workspace &	w
	)

inline

C++ version of gsl_multilarge_nlinear_covar().

Parameters

covar	Covariance matrix of best-fit parameters
w	A gsl::multilarge::nlinear workspace

Returns: Error code on failure

Definition at line 594 of file multilarge_nlinear.hpp.

References covar(), and gsl::multilarge::nlinear::workspace::get().

Referenced by covar().

◆ default_parameters()

parameters gsl::multilarge::nlinear::default_parameters ( )

inline

C++ version of gsl_multilarge_nlinear_default_parameters().

Returns: recommended default parameters

Definition at line 544 of file multilarge_nlinear.hpp.

◆ df()

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

inline

C++ version of gsl_multilarge_nlinear_df().

Parameters

h	UNDOCUMENTED
fdtype	UNDOCUMENTED
x	UNDOCUMENTED
wts	UNDOCUMENTED
fdf	UNDOCUMENTED
f	UNDOCUMENTED
J	UNDOCUMENTED
work	A gsl::multilarge::nlinear::workspace

Returns: Error code on failure

Definition at line 759 of file multilarge_nlinear.hpp.

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

Referenced by gsl::multilarge::nlinear::function_fdf::function_fdf(), and gsl::multilarge::nlinear::function_fdf::operator=().

◆ driver() [1/2]

int gsl::multilarge::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_multilarge_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 609 of file multilarge_nlinear.hpp.

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

◆ driver() [2/2]

int gsl::multilarge::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_multilarge_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	Code for reason for convergence
w	A gsl::multilarge::nlinear workspace

Returns: Error code on failure

Definition at line 638 of file multilarge_nlinear.hpp.

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

◆ eval_df()

int gsl::multilarge::nlinear::eval_df	(	CBLAS_TRANSPOSE_t const	TransJ,
		vector const &	x,
		vector const &	f,
		vector const &	u,
		vector const &	swts,
		double const	h,
		fdtype const	fdtype,
		gsl::multilarge::nlinear::function_fdf &	fdf,
		vector &	v,
		matrix &	JTJ,
		vector &	work
	)

inline

C++ version of gsl_multilarge_nlinear_eval_df().

Parameters

TransJ	UNDOCUMENTED
x	UNDOCUMENTED
f	UNDOCUMENTED
u	UNDOCUMENTED
swts	UNDOCUMENTED
h	UNDOCUMENTED
fdtype	UNDOCUMENTED
fdf	UNDOCUMENTED
v	UNDOCUMENTED
JTJ	UNDOCUMENTED
work	A gsl::multilarge::nlinear::workspace

Returns: Error code on failure

Definition at line 711 of file multilarge_nlinear.hpp.

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

◆ eval_f()

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

inline

C++ version of gsl_multilarge_nlinear_eval_f().

Parameters

fdf	UNDOCUMENTED
x	UNDOCUMENTED
swts	UNDOCUMENTED
y	UNDOCUMENTED

Returns: Error code on vailure

Definition at line 693 of file multilarge_nlinear.hpp.

References gsl::vector::get().

◆ eval_fvv()

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

inline

C++ version of gsl_multilarge_nlinear_eval_fvv().

Parameters

h	UNDOCUMENTED
x	UNDOCUMENTED
v	UNDOCUMENTED
f	UNDOCUMENTED
swts	UNDOCUMENTED
fdf	UNDOCUMENTED
yvv	UNDOCUMENTED
work	A gsl::multilarge::nlinear::workspace

Returns: Error code on failure

Definition at line 730 of file multilarge_nlinear.hpp.

References gsl::vector::get().

◆ fdfvv()

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

inline

C++ version of gsl_multilarge_nlinear_fdfvv().

Parameters

h	UNDOCUMENTED
x	UNDOCUMENTED
v	UNDOCUMENTED
f	UNDOCUMENTED
J	UNDOCUMENTED
swts	UNDOCUMENTED
fdf	UNDOCUMENTED
fvv	UNDOCUMENTED
work	A gsl::multilarge::nlinear::workspace

Returns: Error code on failure

Definition at line 777 of file multilarge_nlinear.hpp.

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

◆ function_constructor()

template<typename T >

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

◆ init()

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

inline

C++ version of gsl_multilarge_nlinear_init().

Parameters

x	A vector
fdf	The system
w	A gsl::multilarg::nlinear::workspace

Returns: Error code on failure

Definition at line 553 of file multilarge_nlinear.hpp.

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

◆ iterate()

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

inline

C++ version of gsl_multilarge_nlinear_iterate().

Parameters

w	A gsl::multilarge::nlinear workspace

Returns: Error code on failure

Definition at line 572 of file multilarge_nlinear.hpp.

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

◆ make_function_fdf()

template<typename T >

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

inline

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

Parameters

t	The function object.

Definition at line 601 of file multilarge_nlinear_function_fdf.hpp.

◆ name()

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

inline

C++ version of gsl_multilarge_nlinear_name().

Parameters

w	A gsl::multilarge::nlinear workspace

Returns: The name of the workspace

Definition at line 648 of file multilarge_nlinear.hpp.

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

◆ niter()

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

inline

C++ version of gsl_multilarge_nlinear_niter().

Parameters

w	A gsl::multilarge::nlinear workspace

Returns: The number of iterations so far

Definition at line 676 of file multilarge_nlinear.hpp.

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

◆ position()

vector gsl::multilarge::nlinear::position ( workspace & w )

inline

C++ version of gsl_multilarge_nlinear_position().

Parameters

w	A gsl::multilarge::nlinear workspace

Returns: The current position (best-fit parameters) of the solver

Definition at line 655 of file multilarge_nlinear.hpp.

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

◆ rcond()

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

inline

C++ version of gsl_multilarge_nlinear_rcond().

Parameters

rcond	reciprocal condition number [return]
w	A gsl::multilarge::nlinear workspace

Returns: Error code on failure

Definition at line 586 of file multilarge_nlinear.hpp.

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

Referenced by rcond().

◆ residual()

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

inline

C++ version of gsl_multilarge_nlinear_residual().

Parameters

w	A gsl::multilarge::nlinear workspace

Returns: Current residual of the solver

Definition at line 662 of file multilarge_nlinear.hpp.

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

◆ step()

vector gsl::multilarge::nlinear::step ( workspace const & w )

inline

C++ version of gsl_multilarge_nlinear_step().

Parameters

w	A gsl::multilarge::nlinear workspace

Returns: UNDOCUMENTED

Definition at line 669 of file multilarge_nlinear.hpp.

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

◆ test()

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

inline

C++ version of gsl_multilarge_nlinear_test().

Parameters

xtol	Tolerance
gtol	Tolerance
ftol	Tolerance
info	Code 0 or GSL_CONTINUE
w	A gsl::multilarge::nlinear::workspace

Returns: Error code on failure

Definition at line 744 of file multilarge_nlinear.hpp.

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

◆ trs_name()

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

inline

C++ version of gsl_multilarge_nlinear_trs_name().

Parameters

w	A gsl::multilarge::nlinear workspace

Returns: Name of trust region subproblem

Definition at line 683 of file multilarge_nlinear.hpp.

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

◆ winit()

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

inline

C++ version of gsl_multilarge_nlinear_winit().

Parameters

x	A vector
wts	A vector
fdf	The system
w	A gsl::multilarge::nlinear workspace

Returns: Error code on failure

Definition at line 564 of file multilarge_nlinear.hpp.

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

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ driver_callback

◆ fdf

◆ fdtype

◆ parameters

◆ scale

◆ solver

◆ trs

◆ type

Function Documentation

◆ avratio()

◆ covar()

◆ default_parameters()

◆ df()

◆ driver() [1/2]

◆ driver() [2/2]

◆ eval_df()

◆ eval_f()

◆ eval_fvv()

◆ fdfvv()

◆ function_constructor()

◆ init()

◆ iterate()

◆ make_function_fdf()

◆ name()

◆ niter()

◆ position()

◆ rcond()

◆ residual()

◆ step()

◆ test()

◆ trs_name()

◆ winit()