1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
// ************************************************************************************************
//
// BornAgain: simulate and fit reflection and scattering
//
//! @file Sim/Fitting/ObjectiveMetricUtil.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 // SWIG
#ifndef BORNAGAIN_SIM_FITTING_OBJECTIVEMETRICUTIL_H
#define BORNAGAIN_SIM_FITTING_OBJECTIVEMETRICUTIL_H
#include <functional>
#include <memory>
#include <string>
#include <vector>
class ObjectiveMetric;
//! Utility functions related to class ObjectiveMetric.
namespace ObjectiveMetricUtil {
//! Returns L1 normalization function.
std::function<double(double)> l1Norm();
//! Returns L2 normalization function.
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 ObjectiveMetricUtil
#endif // BORNAGAIN_SIM_FITTING_OBJECTIVEMETRICUTIL_H
|
