autopas::options::AcquisitionFunctionOption Class Reference

Class representing the acquisition function choices for the Bayesian search. More...

#include <AcquisitionFunctionOption.h>

Inheritance diagram for autopas::options::AcquisitionFunctionOption:

Collaboration diagram for autopas::options::AcquisitionFunctionOption:

Public Types
enum	Value {   upperConfidenceBound , mean , variance , probabilityOfImprovement ,   expectedImprovement }
	Different acquisition functions.

Public Member Functions
	AcquisitionFunctionOption ()=default
	Constructor.
constexpr	AcquisitionFunctionOption (Value option)
	Constructor from value.
constexpr	operator Value () const
	Cast to value.
Public Member Functions inherited from autopas::options::Option< AcquisitionFunctionOption >
	operator bool ()=delete
	Prevents cast to bool by deleting the conversion operator.
std::string	to_string (bool fixedLength=false) const
	Converts an Option object to its respective string representation.

Static Public Member Functions
static std::set< AcquisitionFunctionOption >	getDiscouragedOptions ()
	Set of options that are very unlikely to be interesting.
static std::map< AcquisitionFunctionOption, std::string >	getOptionNames ()
	Provides a way to iterate over the possible choices of AcquisitionFunction.
Static Public Member Functions inherited from autopas::options::Option< AcquisitionFunctionOption >
static std::set< AcquisitionFunctionOption >	getAllOptions ()
	Provides a way to iterate over the possible options.
static std::set< AcquisitionFunctionOption >	getMostOptions ()
	Provides a way to iterate over the possible options minus those that are very unlikely to be on interest.
static size_t	maxStringLength ()
	Returns the number of characters in the string representation of the longest option.
static OutputContainer	parseOptions (const std::string &optionsString)
	Converts a string of options to a set of enums.
static AcquisitionFunctionOption	parseOptionExact (const std::string &optionString)
	Converts a string to an enum.

Detailed Description

Class representing the acquisition function choices for the Bayesian search.

Constructor & Destructor Documentation

AcquisitionFunctionOption()

constexpr autopas::options::AcquisitionFunctionOption::AcquisitionFunctionOption ( Value  option )

inlineconstexpr

Constructor from value.

Parameters

option

Member Function Documentation

getDiscouragedOptions()

static std::set< AcquisitionFunctionOption > autopas::options::AcquisitionFunctionOption::getDiscouragedOptions ( )

inlinestatic

Set of options that are very unlikely to be interesting.

Returns

getOptionNames()

static std::map< AcquisitionFunctionOption, std::string > autopas::options::AcquisitionFunctionOption::getOptionNames ( )

inlinestatic

Provides a way to iterate over the possible choices of AcquisitionFunction.

Returns

map option -> string representation

operator Value()

constexpr autopas::options::AcquisitionFunctionOption::operator Value ( ) const

inlineconstexpr

Cast to value.

Returns

---

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

• autopas/options/AcquisitionFunctionOption.h