OpenMS::OptimizationFunctions Namespace Reference

Namespace for all functions and classes needed for the gsl levenberg-marquard algorithm. More...

Classes
struct	PenaltyFactorsIntensity
	Class for the penalty factors used during the optimization. More...
struct	PenaltyFactors
	Class for the penalty factors used during the optimization. More...
Typedefs
typedef std::vector< Peak1D >	RawDataVector
	Raw data vector type.
typedef RawDataVector::iterator	PeakIterator
	Raw data iterator type.
Functions
int	residual (const gsl_vector *x, void *params, gsl_vector *f)
	Evaluation of the target function for nonlinear optimization.
int	jacobian (const gsl_vector *x, void *params, gsl_matrix *J)
	Compute the Jacobian of the residual, where each row of the matrix corresponds to a point in the data.
int	evaluate (const gsl_vector *x, void *params, gsl_vector *f, gsl_matrix *J)
	Driver function for the evaluation of function and jacobian.
void	printSignal (const gsl_vector *x, void *param, float resolution=0.25)
	Print all peak shapes.

---

Detailed Description

Namespace for all functions and classes needed for the gsl levenberg-marquard algorithm.

We have to use function pointers for the gsl and can't put them into a class, so we provide an extra namespace.

---

Typedef Documentation

typedef RawDataVector::iterator PeakIterator

Raw data iterator type.

typedef std::vector<Peak1D> RawDataVector

Raw data vector type.

---

Function Documentation

int OpenMS::OptimizationFunctions::evaluate	(	const gsl_vector *	x,
		void *	params,
		gsl_vector *	f,
		gsl_matrix *	J
	)

Driver function for the evaluation of function and jacobian.

int OpenMS::OptimizationFunctions::jacobian	(	const gsl_vector *	x,
		void *	params,
		gsl_matrix *	J
	)

Compute the Jacobian of the residual, where each row of the matrix corresponds to a point in the data.

void OpenMS::OptimizationFunctions::printSignal	(	const gsl_vector *	x,
		void *	param,
		float	resolution = 0.25
	)

Print all peak shapes.

int OpenMS::OptimizationFunctions::residual	(	const gsl_vector *	x,
		void *	params,
		gsl_vector *	f
	)

Evaluation of the target function for nonlinear optimization.