MEAL::LeastSquares Class Reference

#include <LeastSquares.h>

Inheritance diagram for MEAL::LeastSquares:

Public Types
typedef std::vector< std::vector< double > >	matrix

Public Member Functions
virtual std::string	get_name () const =0
	Return the name of the fit algorithm.
void	set_maximum_iterations (unsigned maximum_iterations)
	Set the maximum number of iterations in fit algorithm.
unsigned	get_maximum_iterations () const
	Get the maximum number of iterations in fit algorithm.
void	set_convergence_chisq (float chisq)
	Set the convergence threshold as an absolute value of chisq.
void	set_convergence_delta (float delta_parameters)
	Set the convergence threshold as relative change in parameters.
void	set_maximum_reduced_chisq (float maximum_reduced_chisq)
	Set the reduced chi-squared above which the fit is considered bad.
void	set_debug (bool flag=true)
	Set the verbosity during solve.
void	set_solved (bool val)
	Set the solved flag (can be used to flag bad data)
bool	get_solved () const
	Return true when the fit has been solved.
void	set_singular (bool val)
	Set the singular flag (can be used to flag bad data)
bool	get_singular () const
	Return true when the fit has failed due to singularity.
unsigned	get_iterations () const
	The number of iterations in last call to solve method.
float	get_chisq () const
	The chi-squared in last call to solve method.
unsigned	get_nfree () const
	The number of degrees of freedom in last call to solve method.
unsigned	get_nparam_infit () const
	Get the number of parameters in fit.
unsigned	get_ndat_constraint () const
	The total number of constraints (one-dimensional data)
double	get_log_det_curvature () const
	The logarithm of the determinant of the chi-squared curvature matrix.
double	get_log_cond_curvature () const
	The logarithm of the condition number of the chi-squared curvature matrix.
void	get_covariance (matrix &c) const
	Get the covariance matrix of the last fit.
Public Member Functions inherited from Reference::Able
	Able (const Able &)
Able &	operator= (const Able &)
unsigned	get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)
HeapTracked &	operator= (const HeapTracked &)
bool	__is_on_heap () const

Protected Attributes
unsigned	maximum_iterations = 50
	The maximum number of iterations in during fit.
float	convergence_chisq = 0.0
	The convergence chisq.
float	convergence_delta = 0.01
	The convergence delta.
float	maximum_reduced = 0.0
	The maximum reduced chi-squared allowed.
unsigned	iterations = 0
	The number of iterations in last call to solve method.
double	log_det_Hessian = 0.0
	Logarithm of the determinant of the Hessian matrix.
double	log_cond_Hessian = 0.0
	Logarithm of the condition number of the Hessian matrix.
float	best_chisq = 0.0
	The best chi-squared in last call to solve method.
unsigned	nfree = 0
	The number of free parameters in last call to solve method.
unsigned	nparam_infit = 0
	The number of parameters to be fit.
unsigned	ndat_constraint = 0
	The total number of constraints (multi-dimensional data)
bool	debug = false
	The fit debug mode.
bool	solved = false
	Set true when fit has been solved.
bool	singular = false
	Set true when the fit failed due to a singular Hessian matrix.
matrix	covariance
	The covariance matrix set after fitting.

Additional Inherited Members
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()
Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)
static void	operator delete (void *location, void *ptr)
static void	operator delete (void *location)
static size_t	get_heap_queue_size ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

General properties of least squares minimization

---

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

• LeastSquares.h
• LeastSquares.C