TestMinimizer.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Fit/Minimizer/TestMinimizer.h
//! @brief     Defines class TestMinimizer.
//!
//! @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_MINIMIZER_TESTMINIMIZER_H
#define BORNAGAIN_FIT_MINIMIZER_TESTMINIMIZER_H
 
#include "Fit/Minimizer/IMinimizer.h"
 
//! A trivial minimizer that calls the objective function once. Used to test the whole chain.
 
class TestMinimizer : public IMinimizer {
public:
    TestMinimizer();
    ~TestMinimizer() override;
 
    std::string minimizerName() const final;
    std::string algorithmName() const final { return ""; }
 
    mumufit::MinimizerResult minimize_scalar(fcn_scalar_t fcn,
                                             mumufit::Parameters parameters) override;
 
private:
    std::vector<double> m_parameter_values;
    scalar_function_t m_fcn;
};
 
#endif // BORNAGAIN_FIT_MINIMIZER_TESTMINIMIZER_H
#endif // USER_API