#include <gsl_multifit.h>

Public Member Functions
	Gsl_multifit_fdf (const gsl_multifit_fdfsolver_type type, gsl_multifit_function_fdf f, const gsl_vector *x0, size_t data_count, bool verbosity=true)
	TODO: document. More...

	Gsl_multifit_fdf (size_t data_count, size_t size, const gsl_multifit_fdfsolver_type *type=gsl_multifit_fdfsolver_lmsder)

	~Gsl_multifit_fdf ()

void	initialize (gsl_multifit_function_fdf f, const gsl_vector x0)

size_t	dim () const

size_t	num_observations () const

int	iterate ()
	Perform one iteration of the solver. More...

gsl_vector *	position () const
	query the current best argfit of the solver More...

gsl_matrix *	jacobian () const

const gsl_vector *	min () const
	query the current best min value of the function to be minimized More...

int	test_delta (double epsabs, double epsrel) const

int	test_gradient (double epsabs=1e-6) const

void	swap (Gsl_multifit_fdf &that)
	Swap the contents of this solver and another (fast). More...

bool	verbosity (bool v)
	Alter the verbosity attribute of the object. More...

bool	verbosity ()

Constructor & Destructor Documentation

kjb::Gsl_multifit_fdf::Gsl_multifit_fdf	(	const gsl_multifit_fdfsolver_type *	type,
		gsl_multifit_function_fdf *	f,
		const gsl_vector *	x0,
		size_t	data_count,
		bool	verbosity = `true`
	)

inline

TODO: document.

kjb::Gsl_multifit_fdf::Gsl_multifit_fdf	(	size_t	data_count,
		size_t	size,
		const gsl_multifit_fdfsolver_type *	type = `gsl_multifit_fdfsolver_lmsder`
	)

inline

kjb::Gsl_multifit_fdf::~Gsl_multifit_fdf ( )

inline

Member Function Documentation

size_t kjb::Gsl_multifit_fdf::dim ( ) const

inline

void kjb::Gsl_multifit_fdf::initialize	(	gsl_multifit_function_fdf *	f,
		const gsl_vector *	x0
	)

inline

int kjb::Gsl_multifit_fdf::iterate ( )

inline

Perform one iteration of the solver.

Returns: GSL_SUCCESS if successful, or a GSL error code otherwise: http://www.gnu.org/software/gsl/manual/html_node/Error-Codes.html

If you want to throw an exception in the case of a failed iteration, consider using the GSL_ETX macro.

gsl_matrix* kjb::Gsl_multifit_fdf::jacobian ( ) const

inline

const gsl_vector* kjb::Gsl_multifit_fdf::min ( ) const

inline

query the current best min value of the function to be minimized

size_t kjb::Gsl_multifit_fdf::num_observations ( ) const

inline

gsl_vector* kjb::Gsl_multifit_fdf::position ( ) const

inline

query the current best argfit of the solver

void kjb::Gsl_multifit_fdf::swap ( Gsl_multifit_fdf & that )

inline

Swap the contents of this solver and another (fast).

This method is useful if, for example, you want to restart the solver at a new location; just instantiate a new solver object at the new location and swap() it with the old solver object.

int kjb::Gsl_multifit_fdf::test_delta	(	double	epsabs,
		double	epsrel
	)		const

inline

Returns: GSL_SUCCESS if the size is smaller than tolerance epsabs, or GSL_CONTINUE otherwise.

int kjb::Gsl_multifit_fdf::test_gradient ( double epsabs = 1e-6 ) const

inline

Returns: GSL_SUCCESS if the size is smaller than tolerance epsabs, or GSL_CONTINUE otherwise.

bool kjb::Gsl_multifit_fdf::verbosity ( bool v )

inline

Alter the verbosity attribute of the object.

Returns: the previous value of the verbosity attribute. Currently if the object has true-verbosity then you will get an error message if iterate() fails.

bool kjb::Gsl_multifit_fdf::verbosity ( )

inline

Returns: the value of the verbosity attribute.

The documentation for this class was generated from the following file:

/work/kobus/src/lib/gsl_cpp/gsl_multifit.h

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation