shark::VDCMA Class Reference
#include <shark/Algorithms/DirectSearch/VDCMA.h>
Inheritance diagram for shark::VDCMA:
Public Member Functions | |
| VDCMA (random::rng_type &rng=random::globalRng) | |
| Default c'tor. More... | |
| std::string | name () const |
| From INameable: return the class name. More... | |
| std::size_t | suggestLambda (std::size_t dimension) |
| Calculates lambda for the supplied dimensionality n. More... | |
| std::size_t | suggestMu (std::size_t lambda) |
| Calculates mu for the supplied lambda and the recombination strategy. More... | |
| void | init (ObjectiveFunctionType const &function, SearchPointType const &p) |
| initializes the optimizer using a predefined starting point More... | |
| void | init (ObjectiveFunctionType const &function, SearchPointType const &initialSearchPoint, std::size_t lambda, std::size_t mu, double initialSigma) |
| Initializes the algorithm for the supplied objective function. More... | |
| void | step (ObjectiveFunctionType const &function) |
| Executes one iteration of the algorithm. More... | |
| double | sigma () const |
| Accesses the current step size. More... | |
| void | setSigma (double sigma) |
| Accesses the current step size. More... | |
| void | setInitialSigma (double initialSigma) |
| set the initial step size of the algorithm. More... | |
| RealVector const & | mean () const |
| Accesses the current population mean. More... | |
| RealVector const & | weights () const |
| Accesses the current weighting vector. More... | |
| RealVector const & | evolutionPath () const |
| Accesses the evolution path for the covariance matrix update. More... | |
| RealVector const & | evolutionPathSigma () const |
| Accesses the evolution path for the step size update. More... | |
| std::size_t | mu () const |
| Returns the size of the parent population \(\mu\). More... | |
| std::size_t & | mu () |
| Returns a mutabl reference to the size of the parent population \(\mu\). More... | |
| std::size_t | lambda () const |
| Returns a immutable reference to the size of the offspring population \(\mu\). More... | |
| std::size_t & | lambda () |
| Returns a mutable reference to the size of the offspring population \(\mu\). More... | |
| Public Member Functions inherited from shark::AbstractSingleObjectiveOptimizer< RealVector > | |
| std::size_t | numInitPoints () const |
| By default most single objective optimizers only require a single point. More... | |
| virtual void | init (ObjectiveFunctionType const &function, std::vector< SearchPointType > const &initPoints) |
| Initialize the optimizer for the supplied objective function using a set of initialisation points. More... | |
| virtual const SolutionType & | solution () const |
| returns the current solution of the optimizer More... | |
| Public Member Functions inherited from shark::AbstractOptimizer< RealVector, double, SingleObjectiveResultSet< RealVector > > | |
| const Features & | features () const |
| virtual void | updateFeatures () |
| bool | requiresValue () const |
| bool | requiresFirstDerivative () const |
| bool | requiresSecondDerivative () const |
| bool | canSolveConstrained () const |
| bool | requiresClosestFeasible () const |
| virtual | ~AbstractOptimizer () |
| virtual void | init (ObjectiveFunctionType const &function) |
| Initialize the optimizer for the supplied objective function. More... | |
| Public Member Functions inherited from shark::INameable | |
| virtual | ~INameable () |
| Public Member Functions inherited from shark::ISerializable | |
| virtual | ~ISerializable () |
| Virtual d'tor. More... | |
| virtual void | read (InArchive &archive) |
| Read the component from the supplied archive. More... | |
| virtual void | write (OutArchive &archive) const |
| Write the component to the supplied archive. More... | |
| void | load (InArchive &archive, unsigned int version) |
| Versioned loading of components, calls read(...). More... | |
| void | save (OutArchive &archive, unsigned int version) const |
| Versioned storing of components, calls write(...). More... | |
| BOOST_SERIALIZATION_SPLIT_MEMBER () | |
Additional Inherited Members | |
| Public Types inherited from shark::AbstractSingleObjectiveOptimizer< RealVector > | |
| typedef base_type::SearchPointType | SearchPointType |
| typedef base_type::SolutionType | SolutionType |
| typedef base_type::ResultType | ResultType |
| typedef base_type::ObjectiveFunctionType | ObjectiveFunctionType |
| Public Types inherited from shark::AbstractOptimizer< RealVector, double, SingleObjectiveResultSet< RealVector > > | |
| enum | Feature |
| Models features that the optimizer requires from the objective function. More... | |
| typedef RealVector | SearchPointType |
| typedef double | ResultType |
| typedef SingleObjectiveResultSet< RealVector > | SolutionType |
| typedef AbstractObjectiveFunction< RealVector, ResultType > | ObjectiveFunctionType |
| typedef TypedFlags< Feature > | Features |
| typedef TypedFeatureNotAvailableException< Feature > | FeatureNotAvailableException |
| Protected Member Functions inherited from shark::AbstractOptimizer< RealVector, double, SingleObjectiveResultSet< RealVector > > | |
| void | checkFeatures (ObjectiveFunctionType const &objectiveFunction) |
| Convenience function that checks whether the features of the supplied objective function match with the required features of the optimizer. More... | |
| Protected Attributes inherited from shark::AbstractSingleObjectiveOptimizer< RealVector > | |
| SolutionType | m_best |
| Current solution of the optimizer. More... | |
| Protected Attributes inherited from shark::AbstractOptimizer< RealVector, double, SingleObjectiveResultSet< RealVector > > | |
| Features | m_features |
Detailed Description
Constructor & Destructor Documentation
◆ VDCMA()
|
inline |
Default c'tor.
Definition at line 60 of file VDCMA.h.
References shark::AbstractOptimizer< RealVector, double, SingleObjectiveResultSet< RealVector > >::m_features, and shark::AbstractOptimizer< RealVector, double, SingleObjectiveResultSet< RealVector > >::REQUIRES_VALUE.
Member Function Documentation
◆ evolutionPath()
|
inline |
◆ evolutionPathSigma()
|
inline |
◆ init() [1/2]
|
inlinevirtual |
initializes the optimizer using a predefined starting point
Implements shark::AbstractSingleObjectiveOptimizer< RealVector >.
Definition at line 80 of file VDCMA.h.
References shark::AbstractOptimizer< RealVector, double, SingleObjectiveResultSet< RealVector > >::checkFeatures(), lambda(), mu(), sigma(), suggestLambda(), and suggestMu().
◆ init() [2/2]
|
inline |
◆ lambda() [1/2]
|
inline |
◆ lambda() [2/2]
|
inline |
◆ mean()
|
inline |
◆ mu() [1/2]
|
inline |
◆ mu() [2/2]
|
inline |
◆ name()
|
inlinevirtual |
From INameable: return the class name.
Reimplemented from shark::INameable.
◆ setInitialSigma()
|
inline |
set the initial step size of the algorithm.
Sets the initial sigma at init to a given value. If this is 0, which it is by default, the default initialisation will be sigma= 1/sqrt(N) where N is the number of variables to optimize.
this method is the prefered one instead of init()
◆ setSigma()
|
inline |
◆ sigma()
|
inline |
Accesses the current step size.
Definition at line 172 of file VDCMA.h.
Referenced by init(), and setSigma().
◆ step()
|
inlinevirtual |
Executes one iteration of the algorithm.
Implements shark::AbstractOptimizer< RealVector, double, SingleObjectiveResultSet< RealVector > >.
Definition at line 149 of file VDCMA.h.
References shark::AbstractSingleObjectiveOptimizer< RealVector >::m_best, shark::ResultSet< SearchPointT, ResultT >::point, shark::searchPoint(), and shark::ResultSet< SearchPointT, ResultT >::value.
◆ suggestLambda()
|
inline |
◆ suggestMu()
|
inline |
◆ weights()
|
inline |
The documentation for this class was generated from the following file:
- include/shark/Algorithms/DirectSearch/VDCMA.h