autopas::options::ExtrapolationMethodOption Class Reference

Class representing the choices of possible extrapolation methods for predictiveTuning. More...

#include <ExtrapolationMethodOption.h>

Inheritance diagram for autopas::options::ExtrapolationMethodOption:

Collaboration diagram for autopas::options::ExtrapolationMethodOption:

Public Types
enum	Value { linePrediction , linearRegression , newton , lastResult }
	Possible choices for the auto tuner. More...

Public Member Functions
	ExtrapolationMethodOption ()=default
	Constructor.
constexpr	ExtrapolationMethodOption (Value option)
	Constructor from value.
constexpr	operator Value () const
	Cast to value.
Public Member Functions inherited from autopas::options::Option< ExtrapolationMethodOption >
	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::map< ExtrapolationMethodOption, std::string >	getOptionNames ()
	Provides a way to iterate over the possible choices of ExtrapolationMethods.
Static Public Member Functions inherited from autopas::options::Option< ExtrapolationMethodOption >
static std::set< ExtrapolationMethodOption >	getAllOptions ()
	Provides a way to iterate over the possible options.
static std::set< ExtrapolationMethodOption >	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 ExtrapolationMethodOption	parseOptionExact (const std::string &optionString)
	Converts a string to an enum.

Detailed Description

Class representing the choices of possible extrapolation methods for predictiveTuning.

Member Enumeration Documentation

Value

enum autopas::options::ExtrapolationMethodOption::Value

Possible choices for the auto tuner.

Enumerator
linePrediction	Places a line through the last two data points.
linearRegression	Places a line through the last _evidenceFirstPrediction points.
newton	Places a polynomial function through a certain number of data points using Newtons method.
lastResult	Simply use the last traversal time as an estimate (not actually an extrapolation)

Constructor & Destructor Documentation

ExtrapolationMethodOption()

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

inlineconstexpr

Constructor from value.

Parameters

option

Member Function Documentation

getOptionNames()

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

inlinestatic

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

Returns

map option -> string representation

operator Value()

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

inlineconstexpr

Cast to value.

Returns

---

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

• autopas/options/ExtrapolationMethodOption.h