laserIMUCalibration
lm_control_struct Struct Reference

Collection of input parameters for fit control. More...

#include <lmstruct.h>

Data Fields

double ftol
 Relative error desired in the sum of squares. More...
 
double xtol
 Relative error between last two approximations. More...
 
double gtol
 Orthogonality desired between fvec and its derivs. More...
 
double epsilon
 Step used to calculate the Jacobian. More...
 
double stepbound
 Used in determining the initial step bound. More...
 
int patience
 Used to set the maximum number of function evaluations. More...
 
int scale_diag
 If 1, the variables will be rescaled internally. More...
 
FILE * msgfile
 Progress messages will be written to this file. More...
 
int verbosity
 Controls the ouput verbosity. More...
 
int n_maxpri
 Maximum parameters to print. More...
 
int m_maxpri
 Max number of residuals to print. More...
 

Detailed Description

Collection of input parameters for fit control.

Definition at line 33 of file lmstruct.h.

Collaboration diagram for lm_control_struct:
Collaboration graph

Field Documentation

double lm_control_struct::epsilon

Step used to calculate the Jacobian.

Should be slightly larger than the relative error in the user-supplied functions.

Definition at line 59 of file lmstruct.h.

double lm_control_struct::ftol

Relative error desired in the sum of squares.

Termination occurs when both the actual and predicted relative reductions in the sum of squares are at most ftol.

Definition at line 40 of file lmstruct.h.

double lm_control_struct::gtol

Orthogonality desired between fvec and its derivs.

Termination occurs when the cosine of the angle between fvec and any column of the Jacobian is at most gtol in absolute value.

Definition at line 53 of file lmstruct.h.

int lm_control_struct::m_maxpri

Max number of residuals to print.

-1, or max number.

Definition at line 100 of file lmstruct.h.

FILE* lm_control_struct::msgfile

Progress messages will be written to this file.

Definition at line 82 of file lmstruct.h.

int lm_control_struct::n_maxpri

Maximum parameters to print.

-1, or max number.

Definition at line 95 of file lmstruct.h.

int lm_control_struct::patience

Used to set the maximum number of function evaluations.

Sets to patience*(number_of_parameters+1).

Definition at line 73 of file lmstruct.h.

int lm_control_struct::scale_diag

If 1, the variables will be rescaled internally.

Recommended value is 1.

Definition at line 78 of file lmstruct.h.

double lm_control_struct::stepbound

Used in determining the initial step bound.

This bound is set to the product of stepbound and the Euclidean norm of diag*x if nonzero, or else to stepbound itself. In most cases stepbound should lie in the interval (0.1,100.0). Generally, the value 100.0 is recommended.

Definition at line 68 of file lmstruct.h.

int lm_control_struct::verbosity

Controls the ouput verbosity.

Variations Result
OR'ed: 1 print some messages
OR'ed: 2 print Jacobian

Definition at line 90 of file lmstruct.h.

double lm_control_struct::xtol

Relative error between last two approximations.

Termination occurs when the relative error between two consecutive iterates is at most xtol.

Definition at line 46 of file lmstruct.h.


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