ObjectiveMetricUtils.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Core/Fitting/ObjectiveMetricUtils.h
//! @brief     Defines ObjectiveMetric utilities and corresponding namespace.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_CORE_FITTING_OBJECTIVEMETRICUTILS_H
#define BORNAGAIN_CORE_FITTING_OBJECTIVEMETRICUTILS_H
 
#include <functional>
#include <memory>
#include <string>
#include <vector>
 
class ObjectiveMetric;
 
//! Utility functions related to class ObjectiveMetric.
 
namespace ObjectiveMetricUtils {
 
//! Returns L1 normalization function.
const std::function<double(double)> l1Norm();
//! Returns L2 normalization function.
const std::function<double(double)> l2Norm();
 
//! Creates the specified metric with the default norm.
std::unique_ptr<ObjectiveMetric> createMetric(const std::string& metric);
 
//! Creates the metric with the specified norm
std::unique_ptr<ObjectiveMetric> createMetric(std::string metric, std::string norm);
 
//! Prints available metric options
std::string availableMetricOptions();
 
//! Returns the names of the norms used by ObjectiveMetric.
std::vector<std::string> normNames();
 
//! Returns the names of the objective metrics used.
std::vector<std::string> metricNames();
 
//! Returns default norm name.
std::string defaultNormName();
 
//! Returns default metric name.
std::string defaultMetricName();
 
} // namespace ObjectiveMetricUtils
 
#endif // BORNAGAIN_CORE_FITTING_OBJECTIVEMETRICUTILS_H
#endif // USER_API