Provide a list of optimizer and corresponding options to be used with the MetaOptimizer class.
More...
#include <Bpp/Numeric/Function/MetaOptimizer.h>
Provide a list of optimizer and corresponding options to be used with the MetaOptimizer class.
Definition at line 19 of file MetaOptimizer.h.
◆ MetaOptimizerInfos() [1/2]
| bpp::MetaOptimizerInfos::MetaOptimizerInfos |
( |
| ) |
|
|
inline |
◆ MetaOptimizerInfos() [2/2]
◆ ~MetaOptimizerInfos()
| virtual bpp::MetaOptimizerInfos::~MetaOptimizerInfos |
( |
| ) |
|
|
inlinevirtual |
◆ addOptimizer()
| virtual void bpp::MetaOptimizerInfos::addOptimizer |
( |
const std::string & |
name, |
|
|
std::shared_ptr< OptimizerInterface > |
optimizer, |
|
|
const std::vector< std::string > & |
params, |
|
|
unsigned short |
derivatives = 0, |
|
|
const std::string & |
type = IT_TYPE_STEP |
|
) |
| |
|
inlinevirtual |
Add a new optimizer to the set.
- Parameters
-
| name | the name of the optimizer. It is used for display only. |
| optimizer | A pointer toward the optimizer to add. The set will own the underlying object, which will be destroyed together with the set. |
| params | A list of parameter names to optimize with this optimizer. |
| derivatives | 0, 1 or 2: does this parameter use no, first order or second order derivatives? |
| type | For each optimization step, shall we perform a full optimization with this optimizer or only one step? |
Definition at line 77 of file MetaOptimizer.h.
◆ clone()
◆ getIterationType() [1/2]
| virtual std::string& bpp::MetaOptimizerInfos::getIterationType |
( |
size_t |
i | ) |
|
|
inlinevirtual |
- Returns
- The type of iteration to perform for the ith optimizer in the set.
Definition at line 123 of file MetaOptimizer.h.
◆ getIterationType() [2/2]
| virtual const std::string& bpp::MetaOptimizerInfos::getIterationType |
( |
size_t |
i | ) |
const |
|
inlinevirtual |
- Returns
- The type of iteration to perform for the ith optimizer in the set.
Definition at line 127 of file MetaOptimizer.h.
◆ getName()
| virtual const std::string& bpp::MetaOptimizerInfos::getName |
( |
size_t |
i | ) |
const |
|
inlinevirtual |
- Returns
- The display name of the ith optimizer in the set.
Definition at line 89 of file MetaOptimizer.h.
◆ getNumberOfOptimizers()
| virtual size_t bpp::MetaOptimizerInfos::getNumberOfOptimizers |
( |
| ) |
const |
|
inlinevirtual |
- Returns
- The number of optimizers in the set.
Definition at line 141 of file MetaOptimizer.h.
◆ getOptimizer() [1/2]
| virtual std::shared_ptr<OptimizerInterface> bpp::MetaOptimizerInfos::getOptimizer |
( |
size_t |
i | ) |
|
|
inlinevirtual |
- Returns
- A shared pointer toward the ith optimizer in the set.
Definition at line 104 of file MetaOptimizer.h.
◆ getOptimizer() [2/2]
| virtual std::shared_ptr<const OptimizerInterface> bpp::MetaOptimizerInfos::getOptimizer |
( |
size_t |
i | ) |
const |
|
inlinevirtual |
- Returns
- A shared pointer toward the ith optimizer in the set.
Definition at line 109 of file MetaOptimizer.h.
◆ getParameterNames() [1/2]
| virtual std::vector<std::string>& bpp::MetaOptimizerInfos::getParameterNames |
( |
size_t |
i | ) |
|
|
inlinevirtual |
- Returns
- The parameter names associated to the ith optimizer in the set.
Definition at line 114 of file MetaOptimizer.h.
◆ getParameterNames() [2/2]
| virtual const std::vector<std::string>& bpp::MetaOptimizerInfos::getParameterNames |
( |
size_t |
i | ) |
const |
|
inlinevirtual |
- Returns
- The parameter names associated to the ith optimizer in the set.
Definition at line 118 of file MetaOptimizer.h.
◆ operator=()
◆ optimizer() [1/2]
◆ optimizer() [2/2]
◆ requiresFirstOrderDerivatives()
| virtual bool bpp::MetaOptimizerInfos::requiresFirstOrderDerivatives |
( |
size_t |
i | ) |
const |
|
inlinevirtual |
- Returns
- True if the ith optimizer in the set requires first order derivatives.
Definition at line 132 of file MetaOptimizer.h.
◆ requiresSecondOrderDerivatives()
| virtual bool bpp::MetaOptimizerInfos::requiresSecondOrderDerivatives |
( |
size_t |
i | ) |
const |
|
inlinevirtual |
- Returns
- True if the ith optimizer in the set requires second order derivatives.
Definition at line 136 of file MetaOptimizer.h.
◆ derivatives_
| std::vector<unsigned short> bpp::MetaOptimizerInfos::derivatives_ |
|
private |
◆ IT_TYPE_FULL
| string MetaOptimizerInfos::IT_TYPE_FULL = "full" |
|
static |
◆ IT_TYPE_STEP
| string MetaOptimizerInfos::IT_TYPE_STEP = "step" |
|
static |
◆ itTypes_
| std::vector<std::string> bpp::MetaOptimizerInfos::itTypes_ |
|
private |
◆ names_
| std::vector<std::string> bpp::MetaOptimizerInfos::names_ |
|
private |
◆ optimizers_
◆ parameterNames_
| std::vector< std::vector<std::string> > bpp::MetaOptimizerInfos::parameterNames_ |
|
private |
The documentation for this class was generated from the following files:
Inheritance diagram for bpp::MetaOptimizerInfos:
