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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
|
// ************************************************************************************************
//
// BornAgain: simulate and fit reflection and scattering
//
//! @file Fit/Option/MultiOption.h
//! @brief Declares class MultiOption.
//!
//! @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_FIT_OPTION_MULTIOPTION_H
#define BORNAGAIN_FIT_OPTION_MULTIOPTION_H
#include <string>
#include <variant>
//! Stores a single option for minimization algorithm. Int, double, string values are available.
class MultiOption {
public:
using variant_t = std::variant<int, double, std::string>;
MultiOption(const std::string& name = "");
template <typename T>
MultiOption(const std::string& name, const T& t, const std::string& descripion = "");
std::string name() const { return m_name; }
std::string description() const { return m_description; }
void setDescription(const std::string& description);
variant_t& value() { return m_value; }
variant_t& defaultValue() { return m_default_value; }
//! Returns the option's value
template <typename T> T get() const;
//! Returns the option's default value (i.e. used during construction)
template <typename T> T getDefault() const;
//! Returns a string representation of the option's value
std::string value_str();
void setFromString(const std::string& value);
private:
std::string m_name;
std::string m_description;
variant_t m_value;
variant_t m_default_value;
};
template <typename T>
MultiOption::MultiOption(const std::string& name, const T& t, const std::string& descripion)
{
m_name = name;
m_description = descripion;
m_value = t;
m_default_value = t;
}
template <typename T> T MultiOption::get() const
{
return std::get<T>(m_value);
}
template <typename T> T MultiOption::getDefault() const
{
return std::get<T>(m_default_value);
}
#endif // BORNAGAIN_FIT_OPTION_MULTIOPTION_H
|