Minimizer.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Fit/Kernel/Minimizer.h
//! @brief     Defines class Minimizer.
//!
//! @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)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_FIT_KERNEL_MINIMIZER_H
#define BORNAGAIN_FIT_KERNEL_MINIMIZER_H
 
#include "Fit/Minimizer/MinimizerResult.h"
#include "Fit/Minimizer/Types.h"
#include <functional>
#include <memory>
#include <string>
#include <vector>
 
class PyCallback;
class IMinimizer;
 
//! The multi-library, multi-algorithm fit wrapper library.
 
namespace mumufit {
 
class Kernel;
 
//! A main class to run fitting.
//! @ingroup fitting
 
class Minimizer {
public:
    Minimizer();
    ~Minimizer();
 
    void setMinimizer(const std::string& minimizerName, const std::string& algorithmName = "",
                      const std::string& options = "");
 
    void setMinimizer(IMinimizer* minimizer);
 
#ifndef SWIG
    MinimizerResult minimize(fcn_scalar_t fcn, const Parameters& parameters) const;
 
    MinimizerResult minimize(fcn_residual_t fcn, const Parameters& parameters) const;
#endif
 
    //! Finds minimum of user objective function (to be called from Python).
    MinimizerResult minimize(const PyCallback& callback, const Parameters& parameters) const;
 
private:
    std::unique_ptr<Kernel> m_kernel;
};
 
} // namespace mumufit
 
#endif // BORNAGAIN_FIT_KERNEL_MINIMIZER_H