MinimizerInfo Class Reference

Info about a minimizer, including list of defined minimization algorithms. More...

Public Member Functions
	MinimizerInfo ()=delete
	MinimizerInfo (const std::string &minimizerType, const std::string &minimizerDescription)
std::vector< std::string >	algorithmDescriptions () const
	Returns list of string with description of all available algorithms. More...
std::string	algorithmName () const
std::vector< std::string >	algorithmNames () const
	Return list of defined algorithm names. More...
std::string	description () const
std::string	name () const
void	setAlgorithmName (const std::string &algorithmName)
	Sets currently active algorithm. More...

Static Public Member Functions
static MinimizerInfo	buildGeneticInfo ()
	Creates information for TMVA genetic minimizer. More...
static MinimizerInfo	buildGSLLMAInfo ()
	Creates information for GSL's Levenberg-Marquardt. More...
static MinimizerInfo	buildGSLMultiMinInfo (const std::string &defaultAlgo="")
	Creates information for GSLMultiMinMinimizer. More...
static MinimizerInfo	buildGSLSimAnInfo ()
	Creates information for GSL's simmulated annealing algorithm. More...
static MinimizerInfo	buildMinuit2Info (const std::string &defaultAlgo="")
	Creates information for Minuit2Minimizer. More...
static MinimizerInfo	buildTestMinimizerInfo ()
	Creates information for simple test minimizer. More...

Private Member Functions
void	addAlgorithm (const AlgorithmInfo &algorithm)
	Adds minimizer algorithm to the list of defined algorithms. More...
void	addAlgorithm (const std::string &algorithmName, const std::string &algorithmDescription)

Private Attributes
std::vector< AlgorithmInfo >	m_algorithms
std::string	m_current_algorithm
std::string	m_description
std::string	m_name

Detailed Description

Info about a minimizer, including list of defined minimization algorithms.

Definition at line 48 of file MinimizerInfo.h.

Constructor & Destructor Documentation

MinimizerInfo() [1/2]

MinimizerInfo::MinimizerInfo ( )

delete

MinimizerInfo() [2/2]

MinimizerInfo::MinimizerInfo ( const std::string &  minimizerType, const std::string &  minimizerDescription  )

inline

Definition at line 51 of file MinimizerInfo.h.

        : m_name(minimizerType), m_description(minimizerDescription)
    {
    }

Member Function Documentation

addAlgorithm() [1/2]

void MinimizerInfo::addAlgorithm ( const AlgorithmInfo &  algorithm )

private

Adds minimizer algorithm to the list of defined algorithms.

Definition at line 144 of file MinimizerInfo.cpp.

{
    m_current_algorithm = algorithm.name();
    m_algorithms.push_back(algorithm);
}

References m_algorithms, m_current_algorithm, and AlgorithmInfo::name().

Referenced by addAlgorithm(), buildGeneticInfo(), buildGSLLMAInfo(), buildGSLMultiMinInfo(), buildGSLSimAnInfo(), buildMinuit2Info(), and buildTestMinimizerInfo().

Here is the call graph for this function:

addAlgorithm() [2/2]

void MinimizerInfo::addAlgorithm ( const std::string &  algorithmName, const std::string &  algorithmDescription  )

private

Definition at line 150 of file MinimizerInfo.cpp.

{
    addAlgorithm(AlgorithmInfo(algorithmName, algorithmDescription));
}

References addAlgorithm(), and algorithmName().

Here is the call graph for this function:

algorithmDescriptions()

std::vector< std::string > MinimizerInfo::algorithmDescriptions

(

)

const

Returns list of string with description of all available algorithms.

Definition at line 49 of file MinimizerInfo.cpp.

{
    std::vector<std::string> result;
    for (const AlgorithmInfo& algo : m_algorithms)
        result.push_back(algo.description());
    return result;
}

References m_algorithms.

Referenced by MinimizerCatalog::algorithmDescriptions(), and MinimizerFactory::catalogDetailsToString().

algorithmName()

std::string MinimizerInfo::algorithmName ( ) const

inline

Definition at line 62 of file MinimizerInfo.h.

{ return m_current_algorithm; }

References m_current_algorithm.

Referenced by addAlgorithm(), MinimizerAdapter::algorithmName(), MinimizerFactory::catalogDetailsToString(), and setAlgorithmName().

algorithmNames()

std::vector< std::string > MinimizerInfo::algorithmNames

(

)

const

Return list of defined algorithm names.

Definition at line 39 of file MinimizerInfo.cpp.

{
    std::vector<std::string> result;
    for (const AlgorithmInfo& algo : m_algorithms)
        result.push_back(algo.name());
    return result;
}

References m_algorithms.

Referenced by MinimizerCatalog::algorithmNames(), and MinimizerFactory::catalogDetailsToString().

buildGeneticInfo()

MinimizerInfo MinimizerInfo::buildGeneticInfo ( )

static

Creates information for TMVA genetic minimizer.

Definition at line 126 of file MinimizerInfo.cpp.

{
    MinimizerInfo result("Genetic", "Genetic minimizer from TMVA library");
    result.addAlgorithm("Default", "Default algorithm");
    return result;
}

References addAlgorithm().

Referenced by MinimizerCatalog::MinimizerCatalog().

Here is the call graph for this function:

buildGSLLMAInfo()

MinimizerInfo MinimizerInfo::buildGSLLMAInfo ( )

static

Creates information for GSL's Levenberg-Marquardt.

Definition at line 108 of file MinimizerInfo.cpp.

{
    MinimizerInfo result("GSLLMA", "Levenberg-Marquardt from GSL library");
    result.addAlgorithm("Default", "Default algorithm");
    return result;
}

References addAlgorithm().

Referenced by MinimizerCatalog::MinimizerCatalog().

Here is the call graph for this function:

buildGSLMultiMinInfo()

MinimizerInfo MinimizerInfo::buildGSLMultiMinInfo ( const std::string &  defaultAlgo = "" )

static

Creates information for GSLMultiMinMinimizer.

Definition at line 88 of file MinimizerInfo.cpp.

{
    MinimizerInfo result("GSLMultiMin", "MultiMin minimizer from GSL library");
 
    result.addAlgorithm("SteepestDescent", "Steepest descent");
    result.addAlgorithm("ConjugateFR", "Fletcher-Reeves conjugate gradient");
    result.addAlgorithm("ConjugatePR", "Polak-Ribiere conjugate gradient");
    result.addAlgorithm("BFGS", "BFGS conjugate gradient");
    result.addAlgorithm("BFGS2", "BFGS conjugate gradient (Version 2)");
 
    if (defaultAlgo.empty())
        result.setAlgorithmName("ConjugateFR");
    else
        result.setAlgorithmName(defaultAlgo);
 
    return result;
}

References addAlgorithm(), and setAlgorithmName().

Referenced by MinimizerCatalog::MinimizerCatalog().

Here is the call graph for this function:

buildGSLSimAnInfo()

MinimizerInfo MinimizerInfo::buildGSLSimAnInfo ( )

static

Creates information for GSL's simmulated annealing algorithm.

Definition at line 117 of file MinimizerInfo.cpp.

{
    MinimizerInfo result("GSLSimAn", "Simmulated annealing minimizer from GSL library");
    result.addAlgorithm("Default", "Default algorithm");
    return result;
}

References addAlgorithm().

Referenced by MinimizerCatalog::MinimizerCatalog().

Here is the call graph for this function:

buildMinuit2Info()

MinimizerInfo MinimizerInfo::buildMinuit2Info ( const std::string &  defaultAlgo = "" )

static

Creates information for Minuit2Minimizer.

Definition at line 59 of file MinimizerInfo.cpp.

{
    MinimizerInfo result("Minuit2", "Minuit2 minimizer from ROOT library");
 
    result.addAlgorithm(
        "Migrad",
        "Variable-metric method with inexact line search, best minimizer according to ROOT.");
 
    result.addAlgorithm("Simplex", "Simplex method of Nelder and Meadh, robust "
                                   "against big fluctuations in objective function.");
 
    result.addAlgorithm("Combined", "Combination of Migrad and Simplex (if Migrad fails).");
 
    result.addAlgorithm("Scan", "Simple objective function scan, one parameter at a time.");
 
    result.addAlgorithm("Fumili", "Gradient descent minimizer similar to "
                                  "Levenberg-Margquardt, sometimes can be better "
                                  "than all others.");
 
    if (defaultAlgo.empty())
        result.setAlgorithmName("Migrad");
    else
        result.setAlgorithmName(defaultAlgo);
 
    return result;
}

References addAlgorithm(), and setAlgorithmName().

Referenced by MinimizerCatalog::MinimizerCatalog().

Here is the call graph for this function:

buildTestMinimizerInfo()

MinimizerInfo MinimizerInfo::buildTestMinimizerInfo ( )

static

Creates information for simple test minimizer.

Definition at line 135 of file MinimizerInfo.cpp.

{
    MinimizerInfo result("Test", "One-shot minimizer to test whole chain");
    result.addAlgorithm("Default", "Default algorithm");
    return result;
}

References addAlgorithm().

Referenced by MinimizerCatalog::MinimizerCatalog().

Here is the call graph for this function:

description()

std::string MinimizerInfo::description ( ) const

inline

Definition at line 60 of file MinimizerInfo.h.

{ return m_description; }

References m_description.

Referenced by MinimizerFactory::catalogDetailsToString().

name()

std::string MinimizerInfo::name ( ) const

inline

Definition at line 59 of file MinimizerInfo.h.

{ return m_name; }

References m_name.

Referenced by MinimizerFactory::catalogDetailsToString(), and MinimizerAdapter::minimizerName().

setAlgorithmName()

void MinimizerInfo::setAlgorithmName

(

const std::string &

algorithmName

)

Sets currently active algorithm.

Definition at line 19 of file MinimizerInfo.cpp.

{
    for (const AlgorithmInfo& algo : m_algorithms) {
        if (algo.name() == algorithmName) {
            m_current_algorithm = algorithmName;
            return;
        }
    }
 
    std::ostringstream msg;
    msg << "MinimizerInfo::setAlgorithmName() -> Error. Algorithm name '" << algorithmName
        << "' is not in the list of defined algorithms (";
    for (const AlgorithmInfo& algo : m_algorithms)
        msg << algo.name() << " ";
    msg << ")";
    throw std::runtime_error(msg.str());
}

References algorithmName(), m_algorithms, and m_current_algorithm.

Referenced by buildGSLMultiMinInfo(), and buildMinuit2Info().

Here is the call graph for this function:

Member Data Documentation

m_algorithms

std::vector<AlgorithmInfo> MinimizerInfo::m_algorithms

private

Definition at line 80 of file MinimizerInfo.h.

Referenced by addAlgorithm(), algorithmDescriptions(), algorithmNames(), and setAlgorithmName().

m_current_algorithm

std::string MinimizerInfo::m_current_algorithm

private

Definition at line 81 of file MinimizerInfo.h.

Referenced by addAlgorithm(), algorithmName(), and setAlgorithmName().

m_description

std::string MinimizerInfo::m_description

private

Definition at line 79 of file MinimizerInfo.h.

Referenced by description().

m_name

std::string MinimizerInfo::m_name

private

Definition at line 78 of file MinimizerInfo.h.

Referenced by name().

---

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

• /home/www/ba/Fit/Minimizer/MinimizerInfo.h
• /home/www/ba/Fit/Minimizer/MinimizerInfo.cpp