SourceXtractorPlusPlus  0.15
Please provide a description of the project.
Public Types | Public Attributes | List of all members
ModelFitting::LeastSquareSummary Class Reference

Class containing the summary information of solving a least square minimization problem. More...

#include <LeastSquareSummary.h>

Collaboration diagram for ModelFitting::LeastSquareSummary:
[legend]

Public Types

enum  StatusFlag { SUCCESS , MAX_ITER , ERROR }
 

Public Attributes

StatusFlag status_flag = SUCCESS
 Flag indicating if the minimization was successful. More...
 
size_t iteration_no {0}
 The number of iterations. More...
 
std::vector< double > parameter_sigmas {}
 1-sigma margin of error for all the parameters More...
 
int engine_stop_reason {0}
 Engine-specific reason for stopping the fitting. More...
 
boost::any underlying_framework_info {}
 

Detailed Description

Class containing the summary information of solving a least square minimization problem.

Definition at line 38 of file LeastSquareSummary.h.

Member Enumeration Documentation

◆ StatusFlag

Enumerator
SUCCESS 
MAX_ITER 
ERROR 

Definition at line 40 of file LeastSquareSummary.h.

Member Data Documentation

◆ engine_stop_reason

int ModelFitting::LeastSquareSummary::engine_stop_reason {0}

Engine-specific reason for stopping the fitting.

Definition at line 54 of file LeastSquareSummary.h.

Referenced by ModelFitting::GSLEngine::solveProblem().

◆ iteration_no

size_t ModelFitting::LeastSquareSummary::iteration_no {0}

The number of iterations.

Definition at line 48 of file LeastSquareSummary.h.

Referenced by ModelFitting::GSLEngine::solveProblem().

◆ parameter_sigmas

std::vector<double> ModelFitting::LeastSquareSummary::parameter_sigmas {}

1-sigma margin of error for all the parameters

Definition at line 51 of file LeastSquareSummary.h.

Referenced by ModelFitting::GSLEngine::solveProblem().

◆ status_flag

StatusFlag ModelFitting::LeastSquareSummary::status_flag = SUCCESS

Flag indicating if the minimization was successful.

Definition at line 45 of file LeastSquareSummary.h.

Referenced by ModelFitting::GSLEngine::solveProblem().

◆ underlying_framework_info

boost::any ModelFitting::LeastSquareSummary::underlying_framework_info {}

Info of the minimization process, as provided by the underlying framework.

WARNING: Using this result will make your code compatible with only one specific implementation of LeastSquareEngine. This information is provided for completeness, but its usage is discouraged. For more information of the exact type refer to the documentation of the engine implementation you use.

Definition at line 63 of file LeastSquareSummary.h.

Referenced by ModelFitting::GSLEngine::solveProblem().


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