shark::moo::Experiment::Options Class Reference

Options specialization for multi-objective experiments. More...

#include <shark/Algorithms/DirectSearch/Experiments/Experiment.h>

+ Inheritance diagram for shark::moo::Experiment::Options:
+ Collaboration diagram for shark::moo::Experiment::Options:

Public Member Functions

void addDefaultOptions ()
 Inserts default options of the experiment. More...
 
 DEFINE_OPTION (ObjectiveSpaceDimensionTag, objectiveSpaceDimension, unsigned int, 2)
 Dimension of the objective space. More...
 
- Public Member Functions inherited from shark::ExperimentBase::Options
virtual ~Options ()
 Virtual d'tor. More...
 
template<typename Tag >
Tag::type value (const Tag &t)
 Reads the value of the option specified by the tag. More...
 
template<typename Tag >
bool hasValue (const Tag &t)
 Checks whether the option specified by tag has been parsed. More...
 
template<typename Tag >
void addOption (const Tag &t)
 Adds the supplied option tag. More...
 
bool parse (int argc, char **argv)
 Parses the command line. More...
 
template<typename Stream >
void printOptions (Stream &s) const
 Outputs the configured options to the supplied stream. More...
 
 DEFINE_OPTION (ObjectiveFunctionTag, objectiveFunction, std::string,"")
 Name of the objective function, passed to factory. More...
 
 DEFINE_OPTION (SeedTag, seed, unsigned int, 1)
 Seed for the RNG. More...
 
 DEFINE_OPTION (StorageIntervalTag, storageInterval, unsigned int, 100)
 Storage frequency for optimizer results. More...
 
 DEFINE_OPTION (SearchSpaceDimensionTag, searchSpaceDimension, unsigned int, 10)
 Dimension of the search space. More...
 
 DEFINE_OPTION (MaxNoEvaluationsTag, maxNoEvaluations, unsigned int, 50000)
 Termination criterion, maximum number of evaluations. More...
 
 DEFINE_OPTION (TimeLimitTag, timeLimit, unsigned int, 1000)
 Termination criterion, maximum runtime in hours. More...
 
 DEFINE_OPTION (FitnessLimitTag, fitnessLimit, double, 1E-10)
 Termination criterion, fitness limit. More...
 
 DEFINE_OPTION (ResultDirTag, resultDir, std::string,".")
 Directory to place results in. More...
 
 DEFINE_OPTION (AlgorithmConfigFile, algorithmConfigFile, std::string,"")
 Configuration file for the optimizer, JSON syntax. More...
 
 DEFINE_OPTION (ResultFormatTag, resultFormat, std::string,"JSON")
 Result format, either JSON or RawText. More...
 
 DEFINE_SIMPLE_OPTION (AlgorithmUsageTag, algorithmUsage)
 Reports configuration options of the optimizer. More...
 
 DEFINE_SIMPLE_OPTION (DefaultAlgorithmUsageTag, defaultAlgorithmUsage)
 Generates default algorithm configuration file in JSON syntax. More...
 

Additional Inherited Members

- Protected Attributes inherited from shark::ExperimentBase::Options
boost::program_options::options_description m_options
 Stores known options. More...
 
boost::program_options::variables_map m_variablesMap
 Stores parsed options. More...
 

Detailed Description

Options specialization for multi-objective experiments.

Definition at line 248 of file Experiment.h.

Member Function Documentation

void shark::moo::Experiment::Options::addDefaultOptions ( )
inlinevirtual
shark::moo::Experiment::Options::DEFINE_OPTION ( ObjectiveSpaceDimensionTag  ,
objectiveSpaceDimension  ,
unsigned  int,
 
)

Dimension of the objective space.


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