BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Private Attributes | Friends | List of all members
FitProgressInfo Class Reference

The FitProgressInfo class contains all essential information about fit progress. More...

Public Member Functions

 FitProgressInfo ()
 
double chi2 () const
 
int iterationCount () const
 
std::string logInfo () const
 
std::vector< double > parValues () const
 
std::vector< double > simValues () const
 

Private Attributes

double m_chi2
 
int m_iteration_count
 
std::string m_log_info
 
std::vector< double > m_sim_values
 
std::vector< double > m_values
 

Friends

class GUIFitObserver
 

Detailed Description

The FitProgressInfo class contains all essential information about fit progress.

It is send from GUIFitObserver to FitSuiteWidget on every nth iteration.

Definition at line 24 of file FitProgressInfo.h.

Constructor & Destructor Documentation

◆ FitProgressInfo()

FitProgressInfo::FitProgressInfo ( )

Definition at line 17 of file FitProgressInfo.cpp.

17 : m_chi2(0.0), m_iteration_count(0) {}

Member Function Documentation

◆ chi2()

double FitProgressInfo::chi2 ( ) const
inline

Definition at line 28 of file FitProgressInfo.h.

28 { return m_chi2; }

References m_chi2.

Referenced by FitSessionController::updateIterationCount(), and FitSessionController::updateLog().

◆ iterationCount()

int FitProgressInfo::iterationCount ( ) const
inline

Definition at line 29 of file FitProgressInfo.h.

29 { return m_iteration_count; }

References m_iteration_count.

Referenced by FitSessionController::updateIterationCount(), and FitSessionController::updateLog().

◆ logInfo()

std::string FitProgressInfo::logInfo ( ) const
inline

Definition at line 31 of file FitProgressInfo.h.

31 { return m_log_info; }
FitProgressInfo::m_log_info
std::string m_log_info
Definition: FitProgressInfo.h:40

References m_log_info.

◆ parValues()

std::vector<double> FitProgressInfo::parValues ( ) const
inline

Definition at line 30 of file FitProgressInfo.h.

30 { return m_values; }
FitProgressInfo::m_values
std::vector< double > m_values
Definition: FitProgressInfo.h:39

References m_values.

Referenced by FitSessionController::updateFitParameterValues(), and FitSessionController::updateLog().

◆ simValues()

std::vector<double> FitProgressInfo::simValues ( ) const
inline

Definition at line 32 of file FitProgressInfo.h.

32 { return m_sim_values; }
FitProgressInfo::m_sim_values
std::vector< double > m_sim_values
Definition: FitProgressInfo.h:41

References m_sim_values.

Friends And Related Function Documentation

◆ GUIFitObserver

friend class GUIFitObserver
friend

Definition at line 34 of file FitProgressInfo.h.

Member Data Documentation

◆ m_chi2

double FitProgressInfo::m_chi2
private

Definition at line 37 of file FitProgressInfo.h.

Referenced by chi2(), and GUIFitObserver::update().

◆ m_iteration_count

int FitProgressInfo::m_iteration_count
private

Definition at line 38 of file FitProgressInfo.h.

Referenced by iterationCount(), and GUIFitObserver::update().

◆ m_log_info

std::string FitProgressInfo::m_log_info
private

Definition at line 40 of file FitProgressInfo.h.

Referenced by logInfo(), and GUIFitObserver::update().

◆ m_sim_values

std::vector<double> FitProgressInfo::m_sim_values
private

Definition at line 41 of file FitProgressInfo.h.

Referenced by simValues(), and GUIFitObserver::update().

◆ m_values

std::vector<double> FitProgressInfo::m_values
private

Definition at line 39 of file FitProgressInfo.h.

Referenced by parValues(), and GUIFitObserver::update().

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