autopas::Configuration Class Reference

Class containing multiple options that form an algorithm configuration for the pairwise iteration. More...

#include <Configuration.h>

Collaboration diagram for autopas::Configuration:

Public Member Functions
constexpr	Configuration (ContainerOption _container, double _cellSizeFactor, TraversalOption _traversal, LoadEstimatorOption _loadEstimator, DataLayoutOption _dataLayout, Newton3Option _newton3, InteractionTypeOption _interactionType, VectorizationPatternOption _vecPattern)
	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, bool forParameterizedTestName=false) const
	Returns a short string representation of the configuration object, suitable for tabular output or test name.
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.
auto	tie () const
	A tuple (std::tie) of references to all members, in a fixed order.
auto	tie ()
	Non-const overload of tie()

Public Attributes
ContainerOption	container
	Container option.
TraversalOption	traversal
	Traversal option.
VectorizationPatternOption	vecPattern
	Vectorization Pattern 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

Class containing multiple options that form an algorithm configuration for the pairwise iteration.

Constructor & Destructor Documentation

Configuration() [1/2]

constexpr autopas::Configuration::Configuration ( ContainerOption  _container, double  _cellSizeFactor, TraversalOption  _traversal, LoadEstimatorOption  _loadEstimator, DataLayoutOption  _dataLayout, Newton3Option  _newton3, InteractionTypeOption  _interactionType, VectorizationPatternOption  _vecPattern  )

inlineconstexpr

Constructor.

Parameters

_container
_traversal
_loadEstimator
_dataLayout
_newton3
_cellSizeFactor
_interactionType
_vecPattern

Note

needs constexpr (hence inline) constructor to be a literal.

Configuration() [2/2]

constexpr autopas::Configuration::Configuration ( )

inlineconstexpr

Constructor taking no arguments.

Initializes all properties to an invalid choice or false.

Note

needs constexpr (hence inline) constructor to be a literal.

Member Function Documentation

getCSVHeader()

std::string autopas::Configuration::getCSVHeader

(

)

const

Generate a csv header containing all keys from the toString() method.

Returns

Contains the header.

getCSVLine()

std::string autopas::Configuration::getCSVLine

(

)

const

Generate a csv representation containing all values from the toString() method.

Returns

String representing the current configuration.

hasCompatibleValues()

bool autopas::Configuration::hasCompatibleValues

(

)

const

Checks if any of the configuration values are incompatible with each other.

Returns

True if all options are compatible to each other.

hasValidValues()

bool autopas::Configuration::hasValidValues

(

)

const

Returns whether the configuration has been initialized with valid values or as an invalid one.

Does not return false if it has valid values whose combination is invalid (e.g. when the container and traversal do not fit).

Returns

tie() [1/2]

auto autopas::Configuration::tie ( )

inline

Non-const overload of tie()

Returns

Tuple of mutable references to all members.

tie() [2/2]

auto autopas::Configuration::tie ( ) const

inline

A tuple (std::tie) of references to all members, in a fixed order.

Useful for treating the configuration as a tuple and applying it in variadic templates, or in tuple comparison operators, which improves the maintainability of configuration ordering, comparison, hashing, and (de)serialization, as these features do not need to be modified when new configuration components are added, only this tie operator.

Returns

Tuple of const references to all members.

toShortString()

std::string autopas::Configuration::toShortString ( bool  fixedLength = true, bool  forParameterizedTestName = false  ) const

inline

Returns a short string representation of the configuration object, suitable for tabular output or test name.

Parameters

fixedLength	See Option::to_string().
forParameterizedTestName	if true, creates a string representation that is safe for use as a test name.

Returns

Short string representation.

toString()

std::string autopas::Configuration::toString

(

)

const

Returns string representation in JSON style of the configuration object.

Returns

String representation.

---

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

• autopas/tuning/Configuration.h
• autopas/tuning/Configuration.cpp