MinimizerFactory Class Reference

Description

Factory to create minimizers.

Definition at line 26 of file MinimizerFactory.h.

Static Public Member Functions
static const MinimizerCatalog &	catalog ()
static std::string	catalogDetailsToString ()
	Returns multi-line string representing detailed catalog content: minimizer names, list of their algorithms and description, list of minimizer options. More...
static std::string	catalogToString ()
	Returns multi-line string representing catalog content: minimizer names and list of their algorithms. More...
static IMinimizer *	createMinimizer (const std::string &minimizerName, const std::string &algorithmType="", const std::string &optionString="")
static void	printCatalog ()

Member Function Documentation

catalog()

const MinimizerCatalog & MinimizerFactory::catalog ( )

static

Definition at line 124 of file MinimizerFactory.cpp.

{
    static MinimizerCatalog s_catalog;
    return s_catalog;
}

Referenced by catalogDetailsToString(), catalogToString(), and createMinimizer().

catalogDetailsToString()

std::string MinimizerFactory::catalogDetailsToString ( )

static

Returns multi-line string representing detailed catalog content: minimizer names, list of their algorithms and description, list of minimizer options.

Definition at line 85 of file MinimizerFactory.cpp.

{
    const int text_width = 80;
    std::ostringstream result;
    const std::string fmt("%-20s| %-65s\n");
 
    for (const auto& minimizerName : catalog().minimizerNames()) {
        // general info
        const MinimizerInfo& info = catalog().minimizerInfo(minimizerName);
        result << std::string(text_width, '-') << "\n";
        result << boost::format(fmt) % info.name() % info.description();
        result << std::string(text_width, '-') << "\n";
 
        // algorithm names and description
        result << "\nAlgorithm names\n";
        auto algorithmNames = info.algorithmNames();
        auto algorithmDescription = info.algorithmDescriptions();
        for (size_t i = 0; i < algorithmNames.size(); ++i)
            result << boost::format(fmt) % algorithmNames[i] % algorithmDescription[i];
        if (algorithmNames.size() > 1)
            result << boost::format(fmt) % "Default algorithm" % info.algorithmName();
 
        // list of minimizer options
        std::unique_ptr<IMinimizer> minimizer(createMinimizer(minimizerName));
        if (auto* rootMinimizer = dynamic_cast<MinimizerAdapter*>(minimizer.get())) {
            result << "\nOptions\n";
            for (const auto& option : rootMinimizer->options()) {
                std::ostringstream opt;
                opt << std::setw(5) << std::left << option->value_str() << option->description();
                result << boost::format(fmt) % option->name() % opt.str();
            }
        }
 
        result << "\n";
    }
 
    return result.str();
}

References MinimizerInfo::algorithmDescriptions(), MinimizerInfo::algorithmName(), MinimizerInfo::algorithmNames(), catalog(), createMinimizer(), MinimizerInfo::description(), MinimizerCatalog::minimizerInfo(), and MinimizerInfo::name().

Here is the call graph for this function:

catalogToString()

std::string MinimizerFactory::catalogToString ( )

static

Returns multi-line string representing catalog content: minimizer names and list of their algorithms.

Definition at line 77 of file MinimizerFactory.cpp.

{
    return catalog().toString();
}

References catalog(), and MinimizerCatalog::toString().

Referenced by printCatalog().

Here is the call graph for this function:

createMinimizer()

IMinimizer * MinimizerFactory::createMinimizer ( const std::string &  minimizerName, const std::string &  algorithmType = "", const std::string &  optionString = ""  )

static

Definition at line 27 of file MinimizerFactory.cpp.

{
    IMinimizer* result(nullptr);
 
    if (minimizerName == "Minuit2")
        result = new Minuit2Minimizer(algorithmType);
 
    else if (minimizerName == "GSLLMA")
        result = new GSLLevenbergMarquardtMinimizer();
 
 
    else if (minimizerName == "GSLSimAn")
        result = new SimAnMinimizer();
 
 
    else if (minimizerName == "GSLMultiMin")
        result = new GSLMultiMinimizer(algorithmType);
 
 
    else if (minimizerName == "Genetic")
        result = new GeneticMinimizer();
 
 
    if (!result) {
        std::ostringstream ostr;
        ostr << "MinimizerFactory::MinimizerFactory() -> Error! Can't create minimizer for given "
                "collection name '"
             << minimizerName << "' or algorithm '" << algorithmType << "'" << std::endl;
        ostr << "Possible names are:" << std::endl;
 
        ostr << catalog().toString();
        throw std::runtime_error(ostr.str());
    }
 
    if (!optionString.empty())
        result->setOptions(optionString);
 
    return result;
}

References catalog(), IMinimizer::setOptions(), and MinimizerCatalog::toString().

Referenced by catalogDetailsToString(), and mumufit::Kernel::setMinimizer().

Here is the call graph for this function:

printCatalog()

void MinimizerFactory::printCatalog ( )

static

Definition at line 69 of file MinimizerFactory.cpp.

{
    std::cout << catalogToString() << std::endl;
}

References catalogToString().

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Kernel/MinimizerFactory.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/Kernel/MinimizerFactory.cpp