BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
ObjectiveMetricUtils.h File Reference

Defines ObjectiveMetric utilities and corresponding namespace. More...

Go to the source code of this file.

Functions

const std::function< double(double)> ObjectiveMetricUtils::l1Norm ()
 Returns L1 normalization function.
 
const std::function< double(double)> ObjectiveMetricUtils::l2Norm ()
 Returns L2 normalization function.
 
std::unique_ptr< ObjectiveMetricObjectiveMetricUtils::createMetric (const std::string &metric)
 Creates the specified metric with the default norm.
 
std::unique_ptr< ObjectiveMetricObjectiveMetricUtils::createMetric (std::string metric, std::string norm)
 Creates the metric with the specified norm.
 
std::string ObjectiveMetricUtils::availableMetricOptions ()
 Prints available metric options.
 
std::vector< std::string > ObjectiveMetricUtils::normNames ()
 Returns the names of the norms used by ObjectiveMetric.
 
std::vector< std::string > ObjectiveMetricUtils::metricNames ()
 Returns the names of the objective metrics used.
 
std::string ObjectiveMetricUtils::defaultNormName ()
 Returns default norm name.
 
std::string ObjectiveMetricUtils::defaultMetricName ()
 Returns default metric name.
 

Detailed Description

Defines ObjectiveMetric utilities and corresponding namespace.

Homepage:\n http://www.bornagainproject.org
License:\n GNU General Public License v3 or higher (see COPYING)
Authors
Scientific Computing Group at MLZ (see CITATION, AUTHORS)

Definition in file ObjectiveMetricUtils.h.