create solvers based on their short name More...
#include <optimization_algorithm_factory.h>
Public Types | |
| typedef std::list< std::shared_ptr< AbstractOptimizationAlgorithmCreator > > | CreatorList |
Public Member Functions | |
| OptimizationAlgorithmFactory (OptimizationAlgorithmFactory const &)=delete | |
| OptimizationAlgorithmFactory & | operator= (OptimizationAlgorithmFactory const &)=delete |
| void | registerSolver (const std::shared_ptr< AbstractOptimizationAlgorithmCreator > &c) |
| void | unregisterSolver (const std::shared_ptr< AbstractOptimizationAlgorithmCreator > &c) |
| OptimizationAlgorithm * | construct (const std::string &tag, OptimizationAlgorithmProperty &solverProperty) const |
| void | listSolvers (std::ostream &os) const |
| list the known solvers into a stream | |
| const CreatorList & | creatorList () const |
| return the underlying list of creators | |
Static Public Member Functions | |
| static OptimizationAlgorithmFactory * | instance () |
| return the instance | |
| static void | destroy () |
| free the instance | |
Protected Member Functions | |
| OptimizationAlgorithmFactory ()=default | |
| CreatorList::const_iterator | findSolver (const std::string &name) const |
| CreatorList::iterator | findSolver (const std::string &name) |
Protected Attributes | |
| CreatorList | _creator |
Static Private Attributes | |
| static std::unique_ptr< OptimizationAlgorithmFactory > | factoryInstance |
Detailed Description
create solvers based on their short name
Factory to allocate solvers based on their short name. The Factory is implemented as a singleton and the single instance can be accessed via the instance() function.
Definition at line 73 of file optimization_algorithm_factory.h.
Member Typedef Documentation
◆ CreatorList
| typedef std::list<std::shared_ptr<AbstractOptimizationAlgorithmCreator> > g2o::OptimizationAlgorithmFactory::CreatorList |
Definition at line 76 of file optimization_algorithm_factory.h.
Constructor & Destructor Documentation
◆ OptimizationAlgorithmFactory() [1/2]
|
delete |
References OptimizationAlgorithmFactory().
Referenced by instance(), operator=(), and OptimizationAlgorithmFactory().
◆ OptimizationAlgorithmFactory() [2/2]
|
protecteddefault |
Member Function Documentation
◆ construct()
| OptimizationAlgorithm * g2o::OptimizationAlgorithmFactory::construct | ( | const std::string & | tag, |
| OptimizationAlgorithmProperty & | solverProperty ) const |
construct a solver based on its name, e.g., var, fix3_2_cholmod
Definition at line 74 of file optimization_algorithm_factory.cpp.
References _creator, findSolver(), and G2O_WARN.
Referenced by MainWindow::allocateSolver(), g2o::SparseOptimizerOnline::initSolver(), main(), and operator=().
◆ creatorList()
|
inline |
return the underlying list of creators
Definition at line 111 of file optimization_algorithm_factory.h.
References _creator.
Referenced by MainWindow::updateDisplayedSolvers().
◆ destroy()
|
static |
free the instance
Definition at line 86 of file optimization_algorithm_factory.cpp.
References factoryInstance.
◆ findSolver() [1/2]
|
protected |
Definition at line 119 of file optimization_algorithm_factory.cpp.
References _creator, and g2o::OptimizationAlgorithmProperty::name.
◆ findSolver() [2/2]
|
protected |
Definition at line 109 of file optimization_algorithm_factory.cpp.
References _creator, and g2o::OptimizationAlgorithmProperty::name.
Referenced by construct(), registerSolver(), and unregisterSolver().
◆ instance()
|
static |
return the instance
Definition at line 46 of file optimization_algorithm_factory.cpp.
References factoryInstance, and OptimizationAlgorithmFactory().
Referenced by MainWindow::allocateSolver(), g2o::SparseOptimizerOnline::initSolver(), main(), main(), g2o::RegisterOptimizationAlgorithmProxy::RegisterOptimizationAlgorithmProxy(), and MainWindow::updateDisplayedSolvers().
◆ listSolvers()
| void g2o::OptimizationAlgorithmFactory::listSolvers | ( | std::ostream & | os | ) | const |
list the known solvers into a stream
Definition at line 91 of file optimization_algorithm_factory.cpp.
References _creator, g2o::OptimizationAlgorithmProperty::desc, g2o::OptimizationAlgorithmProperty::name, and g2o::OptimizationAlgorithmProperty::type.
Referenced by main(), and operator=().
◆ operator=()
|
delete |
References construct(), listSolvers(), OptimizationAlgorithmFactory(), registerSolver(), and unregisterSolver().
◆ registerSolver()
| void g2o::OptimizationAlgorithmFactory::registerSolver | ( | const std::shared_ptr< AbstractOptimizationAlgorithmCreator > & | c | ) |
register a specific creator for allocating a solver
Definition at line 53 of file optimization_algorithm_factory.cpp.
References _creator, findSolver(), and G2O_WARN.
Referenced by operator=(), and g2o::RegisterOptimizationAlgorithmProxy::RegisterOptimizationAlgorithmProxy().
◆ unregisterSolver()
| void g2o::OptimizationAlgorithmFactory::unregisterSolver | ( | const std::shared_ptr< AbstractOptimizationAlgorithmCreator > & | c | ) |
unregister a specific creator for allocating a solver
Definition at line 65 of file optimization_algorithm_factory.cpp.
References _creator, and findSolver().
Referenced by operator=().
Member Data Documentation
◆ _creator
|
protected |
Definition at line 116 of file optimization_algorithm_factory.h.
Referenced by construct(), creatorList(), findSolver(), findSolver(), listSolvers(), registerSolver(), and unregisterSolver().
◆ factoryInstance
|
staticprivate |
Definition at line 122 of file optimization_algorithm_factory.h.
Referenced by destroy(), and instance().
The documentation for this class was generated from the following files:
- /build/reproducible-path/g2o-0~20230806/g2o/core/optimization_algorithm_factory.h
- /build/reproducible-path/g2o-0~20230806/g2o/core/optimization_algorithm_factory.cpp
Generated on for g2o by
1.15.0