Class containing the summary information of solving a least square minimization problem. More...
#include <LeastSquareSummary.h>
Public Types | |
| enum | StatusFlag { SUCCESS , MAX_ITER , ERROR , MEMORY } |
Public Attributes | |
| StatusFlag | status_flag = SUCCESS |
| Flag indicating if the minimization was successful. | |
| size_t | iteration_no {0} |
| The number of iterations. | |
| std::vector< double > | parameter_sigmas {} |
| 1-sigma margin of error for all the parameters | |
| int | engine_stop_reason {0} |
| Engine-specific reason for stopping the fitting. | |
| float | duration |
| Runtime (in seconds) | |
| 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 | |
| MEMORY | |
Definition at line 40 of file LeastSquareSummary.h.
Member Data Documentation
◆ duration
| float ModelFitting::LeastSquareSummary::duration |
Runtime (in seconds)
Definition at line 57 of file LeastSquareSummary.h.
◆ 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.
◆ iteration_no
| size_t ModelFitting::LeastSquareSummary::iteration_no {0} |
The number of iterations.
Definition at line 48 of file LeastSquareSummary.h.
◆ 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.
◆ status_flag
| StatusFlag ModelFitting::LeastSquareSummary::status_flag = SUCCESS |
Flag indicating if the minimization was successful.
Definition at line 45 of file LeastSquareSummary.h.
◆ 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 66 of file LeastSquareSummary.h.
The documentation for this class was generated from the following file:
- ModelFitting/ModelFitting/Engine/LeastSquareSummary.h
