BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
anonymous_namespace{MinimizerResultUtils.cpp} Namespace Reference

Functions

template<typename T >
std::string reportValue (const std::string &name, T value)
 
std::string reportDescription (const RootMinimizerAdapter &minimizer)
 
std::string reportOption (const RootMinimizerAdapter &minimizer)
 
std::string reportStatus (const RootMinimizerAdapter &minimizer)
 

Variables

const int column_width = 18
 

Function Documentation

◆ reportValue()

template<typename T >
std::string anonymous_namespace{MinimizerResultUtils.cpp}::reportValue ( const std::string &  name,
value 
)

Definition at line 29 of file MinimizerResultUtils.cpp.

30 {
31  std::ostringstream result;
32  result << std::setw(column_width) << std::left << name << ": " << value << std::endl;
33  return result.str();
34 }

References column_width.

Referenced by reportDescription(), reportOption(), and reportStatus().

◆ reportDescription()

std::string anonymous_namespace{MinimizerResultUtils.cpp}::reportDescription ( const RootMinimizerAdapter minimizer)

Definition at line 85 of file MinimizerResultUtils.cpp.

86 {
87  std::ostringstream result;
88  result << reportValue("MinimizerType", minimizer.minimizerName());
89  result << reportValue("AlgorithmName", minimizer.algorithmName());
90  return result.str();
91 }
std::string minimizerName() const override final
Returns name of the minimizer.
std::string algorithmName() const override final
Returns name of the minimization algorithm.
std::string reportValue(const std::string &name, T value)

References RootMinimizerAdapter::algorithmName(), RootMinimizerAdapter::minimizerName(), and reportValue().

Referenced by MinimizerResultUtils::reportToString().

Here is the call graph for this function:

◆ reportOption()

std::string anonymous_namespace{MinimizerResultUtils.cpp}::reportOption ( const RootMinimizerAdapter minimizer)

Definition at line 93 of file MinimizerResultUtils.cpp.

94 {
95  if (minimizer.options().empty())
96  return "";
97 
98  std::ostringstream result;
99  result << MinimizerUtils::sectionString("Options");
100  for (auto option : minimizer.options()) {
101  std::ostringstream opt;
102  opt << std::setw(5) << std::left << option->value() << option->description();
103  result << reportValue(option->name(), opt.str());
104  }
105  result << MinimizerUtils::sectionString("OptionString");
106  result << minimizer.options().toOptionString() << std::endl;
107 
108  return result.str();
109 }
std::string toOptionString() const
Returns string with all options (i.e. "Strategy=1;Tolerance=0.01;")
bool empty() const
MinimizerOptions & options()
std::string sectionString(const std::string &sectionName="", size_t report_width=80)
Returns horizontal line of 80 characters length with section name in it.

References OptionContainer::empty(), RootMinimizerAdapter::options(), reportValue(), MinimizerUtils::sectionString(), and MinimizerOptions::toOptionString().

Referenced by MinimizerResultUtils::reportToString().

Here is the call graph for this function:

◆ reportStatus()

std::string anonymous_namespace{MinimizerResultUtils.cpp}::reportStatus ( const RootMinimizerAdapter minimizer)

Definition at line 111 of file MinimizerResultUtils.cpp.

112 {
113  std::ostringstream result;
114  result << MinimizerUtils::sectionString("Status");
115 
116  auto status = minimizer.statusMap();
117  for (auto it : status)
118  result << reportValue(it.first, it.second);
119 
120  return result.str();
121 }
virtual std::map< std::string, std::string > statusMap() const
Returns map of string representing different minimizer statuses.

References reportValue(), MinimizerUtils::sectionString(), and RootMinimizerAdapter::statusMap().

Referenced by MinimizerResultUtils::reportToString().

Here is the call graph for this function:

Variable Documentation

◆ column_width

const int anonymous_namespace{MinimizerResultUtils.cpp}::column_width = 18

Definition at line 27 of file MinimizerResultUtils.cpp.

Referenced by reportValue().