MinimizerAdapter.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Fit/Adapter/MinimizerAdapter.h
//! @brief     Declares class MinimizerAdapter.
//!
//! @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_FIT_ADAPTER_MINIMIZERADAPTER_H
#define BORNAGAIN_FIT_ADAPTER_MINIMIZERADAPTER_H
 
#include "Fit/Minimizer/IMinimizer.h"
#include "Fit/Minimizer/MinimizerInfo.h"
#include "Fit/Minimizer/MinimizerOptions.h"
#include <memory>
#include <string>
 
namespace mumufit {
 
class Parameters;
class Parameter;
class ObjectiveFunctionAdapter;
class MinimizerResult;
 
} // namespace mumufit
 
namespace ROOT::Math {
 
class Minimizer;
}
 
//! Abstract base class that adapts the CERN ROOT minimizer to our IMinimizer.
 
class MinimizerAdapter : public IMinimizer {
public:
    using root_minimizer_t = ROOT::Math::Minimizer;
 
    ~MinimizerAdapter() override;
 
    mumufit::MinimizerResult minimize_scalar(fcn_scalar_t fcn,
                                             mumufit::Parameters parameters) override;
    mumufit::MinimizerResult minimize_residual(fcn_residual_t fcn,
                                               mumufit::Parameters parameters) override;
 
    //! Returns name of the minimizer.
    std::string minimizerName() const override;
 
    //! Returns name of the minimization algorithm.
    std::string algorithmName() const override;
 
    void setParameters(const mumufit::Parameters& parameters);
 
    double minValue() const override;
 
    MinimizerOptions& options() { return m_options; }
    const MinimizerOptions& options() const { return m_options; }
 
    //! Returns string representation of current minimizer status.
    virtual std::string statusToString() const;
 
    //! Returns true if minimizer provides error and error matrix
    bool providesError() const;
 
    //! Returns map of string representing different minimizer statuses
    virtual std::map<std::string, std::string> statusMap() const;
 
    //! Sets option string to the minimizer
    void setOptions(const std::string& optionString) override;
 
protected:
    explicit MinimizerAdapter(MinimizerInfo minimizerInfo);
 
    mumufit::MinimizerResult minimize(mumufit::Parameters parameters);
 
    void propagateResults(mumufit::Parameters& parameters);
 
    virtual void setParameter(unsigned int index, const mumufit::Parameter& par);
    size_t fitRank() const;
    std::vector<double> parValuesAtMinimum() const;
    std::vector<double> parErrorsAtMinimum() const;
 
    virtual void propagateOptions() = 0;
    virtual const root_minimizer_t* rootMinimizer() const = 0;
    root_minimizer_t* rootMinimizer();
 
    template <class T>
    OptionContainer::option_t addOption(const std::string& optionName, T value,
                                        const std::string& description = "");
 
    template <class T>
    void setOptionValue(const std::string& optionName, T value);
 
    template <class T>
    T optionValue(const std::string& optionName) const;
 
private:
    MinimizerOptions m_options;
    MinimizerInfo m_minimizerInfo;
    std::unique_ptr<mumufit::ObjectiveFunctionAdapter> m_adapter;
    bool m_status;
};
 
template <class T>
OptionContainer::option_t MinimizerAdapter::addOption(const std::string& optionName, T value,
                                                      const std::string& description)
{
    return m_options.addOption(optionName, value, description);
}
 
template <class T>
void MinimizerAdapter::setOptionValue(const std::string& optionName, T value)
{
    m_options.setOptionValue(optionName, value);
}
 
template <class T>
T MinimizerAdapter::optionValue(const std::string& optionName) const
{
    return m_options.optionValue<T>(optionName);
}
 
#endif // BORNAGAIN_FIT_ADAPTER_MINIMIZERADAPTER_H
#endif // USER_API