autopas::FeatureVector Class Reference

FeatureVector representation of a Configuration. More...

#include <FeatureVector.h>

Inheritance diagram for autopas::FeatureVector:

Collaboration diagram for autopas::FeatureVector:

Public Types
using	ContainerTraversalEstimatorOption = std::tuple< ContainerOption, TraversalOption, LoadEstimatorOption >
	Consider Container, Traversal and LoadEstimator options as one dimension.

Public Member Functions
	FeatureVector ()
	Default constructor.
	FeatureVector (ContainerOption container, double cellSizeFactor, TraversalOption traversal, LoadEstimatorOption loadEstimator, DataLayoutOption dataLayout, Newton3Option newton3, InteractionTypeOption interactionType)
	Constructor.
	FeatureVector (Configuration conf)
	Construct from Configuration.
Eigen::VectorXd	operator- (const FeatureVector &other) const
	Distance between two FeatureVectors.
Public Member Functions inherited from autopas::Configuration
constexpr	Configuration (ContainerOption _container, double _cellSizeFactor, TraversalOption _traversal, LoadEstimatorOption _loadEstimator, DataLayoutOption _dataLayout, Newton3Option _newton3, InteractionTypeOption _interactionType)
	Constructor.
constexpr	Configuration ()
	Constructor taking no arguments.
std::string	toString () const
	Returns string representation in JSON style of the configuration object.
std::string	toShortString (bool fixedLength=true) const
	Returns a short string representation of the configuration object, suitable for tabular output.
std::string	getCSVHeader () const
	Generate a csv header containing all keys from the toString() method.
std::string	getCSVLine () const
	Generate a csv representation containing all values from the toString() method.
bool	hasValidValues () const
	Returns whether the configuration has been initialized with valid values or as an invalid one.
bool	hasCompatibleValues () const
	Checks if any of the configuration values are incompatible with each other.
bool	equalsDiscreteOptions (const Configuration &rhs) const
	Check if all discrete options of the given configuration are equal to this'.
bool	equalsContinuousOptions (const autopas::Configuration &rhs, double epsilon=1e-12) const
	Check if all continuous options of the given configuration are equal to this configuration.

Static Public Attributes
static constexpr size_t	featureSpaceDims = 4
	Number of tune-able dimensions.

Additional Inherited Members
Public Attributes inherited from autopas::Configuration
ContainerOption	container
	Container option.
TraversalOption	traversal
	Traversal option.
LoadEstimatorOption	loadEstimator
	Load Estimator option.
DataLayoutOption	dataLayout
	Data Layout option.
Newton3Option	newton3
	Newton 3 option.
double	cellSizeFactor
	CellSizeFactor.
InteractionTypeOption	interactionType
	Interaction type of the configuration.

Detailed Description

FeatureVector representation of a Configuration.

Constructor & Destructor Documentation

FeatureVector() [1/3]

autopas::FeatureVector::FeatureVector ( )

inline

Default constructor.

Results in invalid vector.

FeatureVector() [2/3]

autopas::FeatureVector::FeatureVector ( ContainerOption  container, double  cellSizeFactor, TraversalOption  traversal, LoadEstimatorOption  loadEstimator, DataLayoutOption  dataLayout, Newton3Option  newton3, InteractionTypeOption  interactionType  )

inline

Constructor.

Parameters

container
traversal
loadEstimator
dataLayout
newton3
cellSizeFactor
interactionType

FeatureVector() [3/3]

autopas::FeatureVector::FeatureVector ( Configuration  conf )

inline

Construct from Configuration.

Parameters

conf

Member Function Documentation

operator-()

Eigen::VectorXd autopas::FeatureVector::operator- ( const FeatureVector &  other ) const

inline

Distance between two FeatureVectors.

Since there is no real ordering all discrete options are assumed to have a distance of one to each other.

Parameters

other

Returns

Member Data Documentation

featureSpaceDims

constexpr size_t autopas::FeatureVector::featureSpaceDims = 4

staticconstexpr

Number of tune-able dimensions.

container-traversal-estimator + dataLayout + newton3 + cellSizeFactor Interaction type is not a tunable dimension.

---

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

• autopas/tuning/utils/FeatureVector.h