autopas::TuningMetricOption Class Reference

Class representing the load estimator choices. More...

#include <TuningMetricOption.h>

Inheritance diagram for autopas::TuningMetricOption:

Collaboration diagram for autopas::TuningMetricOption:

Public Types
enum	Value { time , energy }
	Possible choices for the load estimation algorithm. More...

Public Member Functions
	TuningMetricOption ()=default
	Constructor.
constexpr	TuningMetricOption (Value option)
	Constructor from value.
constexpr	operator Value () const
	Cast to value.

Static Public Member Functions
static std::set< TuningMetricOption >	getDiscouragedOptions ()
	Set of options that are very unlikely to be interesting.
static std::map< TuningMetricOption, std::string >	getOptionNames ()
	Provides a way to iterate over the possible choices of LoadEstimatorOption.

Detailed Description

Class representing the load estimator choices.

Member Enumeration Documentation

Value

enum autopas::TuningMetricOption::Value

Possible choices for the load estimation algorithm.

Enumerator
time	Optimize for shortest simulation time.
energy	Optimize for least energy usage.

Constructor & Destructor Documentation

TuningMetricOption()

constexpr autopas::TuningMetricOption::TuningMetricOption ( Value  option )

inlineconstexpr

Constructor from value.

Parameters

option

Member Function Documentation

getDiscouragedOptions()

static std::set< TuningMetricOption > autopas::TuningMetricOption::getDiscouragedOptions ( )

inlinestatic

Set of options that are very unlikely to be interesting.

Returns

getOptionNames()

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

inlinestatic

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

Returns

map option -> string representation

operator Value()

constexpr autopas::TuningMetricOption::operator Value ( ) const

inlineconstexpr

Cast to value.

Returns

---

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

• autopas/options/TuningMetricOption.h