MinimizerCatalog.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Fit/Minimizer/MinimizerCatalog.h
//! @brief     Defines class MinimizerCatalog.
//!
//! @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 USER_API
#ifndef BORNAGAIN_FIT_MINIMIZER_MINIMIZERCATALOG_H
#define BORNAGAIN_FIT_MINIMIZER_MINIMIZERCATALOG_H
 
#include "Fit/Minimizer/MinimizerInfo.h"
 
//! Hard-coded information about all minimizers available.
 
/*
--------------------------------------------------------------------------------
Minimizer      | Algorithms
--------------------------------------------------------------------------------
Minuit2        | Migrad Simplex Combined Scan Fumili
GSLMultiMin    | SteepestDescent ConjugateFR ConjugatePR BFGS BFGS2
GSLLMA         | Default
GSLSimAn       | Default
Genetic        | Default
Test           | Default
*/
 
class MinimizerCatalog {
public:
    MinimizerCatalog();
    MinimizerCatalog(const MinimizerCatalog&) = delete;
    MinimizerCatalog(MinimizerCatalog&&) = default;
 
    std::string toString() const;
 
    std::vector<std::string> minimizerNames() const;
 
    std::vector<std::string> algorithmNames(const std::string& minimizerName) const;
 
    std::vector<std::string> algorithmDescriptions(const std::string& minimizerName) const;
 
    const MinimizerInfo& minimizerInfo(const std::string& minimizerName) const;
 
private:
    void addMinimizerInfo(MinimizerInfo&& info);
    std::vector<MinimizerInfo> m_minimizers;
};
 
#endif // BORNAGAIN_FIT_MINIMIZER_MINIMIZERCATALOG_H
#endif // USER_API